api.md

Accounts

Types:

from fireapi_v2.types import AccountInfo

Methods:

• client.accounts.retrieve() -> AccountInfo

Services

Types:

from fireapi_v2.types.accounts import ServiceListResponse

Methods:

• client.accounts.services.list() -> object

Donations

Types:

from fireapi_v2.types.accounts import DonationListResponse

Methods:

• client.accounts.donations.list() -> object

Affiliate

Types:

from fireapi_v2.types.accounts import AffiliateRetrieveResponse

Methods:

• client.accounts.affiliate.retrieve() -> object

Domains

Types:

from fireapi_v2.types import DomainRetrieveResponse

Methods:

• client.domains.retrieve(internal_id) -> object

DNS

Types:

from fireapi_v2.types.domains import (
    DNSRetrieveResponse,
    DNSAddResponse,
    DNSEditResponse,
    DNSRemoveResponse,
)

Methods:

• client.domains.dns.retrieve(internal_id) -> object
• client.domains.dns.add(internal_id, **params) -> object
• client.domains.dns.edit(internal_id, **params) -> object
• client.domains.dns.remove(internal_id, **params) -> object

Kvms

Backup

Types:

from fireapi_v2.types.kvms import BackupListResponse

Methods:

• client.kvms.backup.list(internal_id) -> object

Kvm

Types:

from fireapi_v2.types import KvmPowerResponse

Methods:

• client.kvm.power(internal_id, **params) -> object

Backup

Types:

from fireapi_v2.types.kvm import (
    BackupCreateResponse,
    BackupDeleteResponse,
    BackupCreateStatusResponse,
    BackupRestoreResponse,
    BackupRestoreStatusResponse,
)

Methods:

• client.kvm.backup.create(internal_id, **params) -> object
• client.kvm.backup.delete(internal_id, **params) -> object
• client.kvm.backup.create_status(internal_id, **params) -> object
• client.kvm.backup.restore(internal_id, **params) -> object
• client.kvm.backup.restore_status(internal_id, **params) -> object

Traffic

Types:

from fireapi_v2.types.kvm import TrafficRetrieveResponse, TrafficChartResponse, TrafficLogResponse

Methods:

• client.kvm.traffic.retrieve(internal_id) -> object
• client.kvm.traffic.chart(internal_id, **params) -> object
• client.kvm.traffic.log(internal_id) -> object

Monitoring

Types:

from fireapi_v2.types.kvm import MonitoringIncidencesResponse, MonitoringTimingsResponse

Methods:

• client.kvm.monitoring.incidences(internal_id) -> object
• client.kvm.monitoring.timings(internal_id) -> object

Ddos

Types:

from fireapi_v2.types.kvm import DdoRetrieveResponse, DdoChangeResponse

Methods:

• client.kvm.ddos.retrieve(internal_id) -> object
• client.kvm.ddos.change(internal_id, **params) -> object

Config

Types:

from fireapi_v2.types.kvm import ConfigRetrieveResponse

Methods:

• client.kvm.config.retrieve(internal_id) -> object

Status

Types:

from fireapi_v2.types.kvm import StatusRetrieveResponse

Methods:

• client.kvm.status.retrieve(internal_id) -> object

Webspaces

Types:

from fireapi_v2.types import WebspaceRetrieveResponse

Methods:

• client.webspaces.retrieve(internal_id) -> object