api.md

DNS

DNSSEC

Types:

• DNSSEC
• DNSSECDeleteResponse

Methods:

• client.dns.dnssec.delete({ ...params }) -> DNSSECDeleteResponse
• client.dns.dnssec.edit({ ...params }) -> DNSSEC
• client.dns.dnssec.get({ ...params }) -> DNSSEC

Records

Types:

• ARecord
• AAAARecord
• BatchPatch
• BatchPut
• CAARecord
• CERTRecord
• CNAMERecord
• DNSKEYRecord
• DSRecord
• HTTPSRecord
• LOCRecord
• MXRecord
• NAPTRRecord
• NSRecord
• PTRRecord
• Record
• RecordResponse
• RecordTags
• SMIMEARecord
• SRVRecord
• SSHFPRecord
• SVCBRecord
• TLSARecord
• TTL
• TXTRecord
• URIRecord
• RecordDeleteResponse
• RecordBatchResponse
• RecordExportResponse
• RecordImportResponse
• RecordScanResponse
• RecordScanReviewResponse
• RecordScanTriggerResponse

Methods:

• client.dns.records.create({ ...params }) -> RecordResponse
• client.dns.records.update(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.list({ ...params }) -> RecordResponsesV4PagePaginationArray
• client.dns.records.delete(dnsRecordId, { ...params }) -> RecordDeleteResponse
• client.dns.records.batch({ ...params }) -> RecordBatchResponse
• client.dns.records.edit(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.export({ ...params }) -> string
• client.dns.records.get(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.import({ ...params }) -> RecordImportResponse
• client.dns.records.scan({ ...params }) -> RecordScanResponse
• client.dns.records.scanList({ ...params }) -> RecordResponsesSinglePage
• client.dns.records.scanReview({ ...params }) -> RecordScanReviewResponse
• client.dns.records.scanTrigger({ ...params }) -> RecordScanTriggerResponse

Usage

Zone

Types:

• ZoneGetResponse

Methods:

• client.dns.usage.zone.get({ ...params }) -> ZoneGetResponse

Account

Types:

• AccountGetResponse

Methods:

• client.dns.usage.account.get({ ...params }) -> AccountGetResponse

Settings

Zone

Types:

• ZoneEditResponse
• ZoneGetResponse

Methods:

• client.dns.settings.zone.edit({ ...params }) -> ZoneEditResponse
• client.dns.settings.zone.get({ ...params }) -> ZoneGetResponse

Account

Types:

• AccountEditResponse
• AccountGetResponse

Methods:

• client.dns.settings.account.edit({ ...params }) -> AccountEditResponse
• client.dns.settings.account.get({ ...params }) -> AccountGetResponse

Views

Types:

• ViewCreateResponse
• ViewListResponse
• ViewDeleteResponse
• ViewEditResponse
• ViewGetResponse

Methods:

• client.dns.settings.account.views.create({ ...params }) -> ViewCreateResponse
• client.dns.settings.account.views.list({ ...params }) -> ViewListResponsesV4PagePaginationArray
• client.dns.settings.account.views.delete(viewId, { ...params }) -> ViewDeleteResponse
• client.dns.settings.account.views.edit(viewId, { ...params }) -> ViewEditResponse
• client.dns.settings.account.views.get(viewId, { ...params }) -> ViewGetResponse

Analytics

Reports

Types:

• Report

Methods:

• client.dns.analytics.reports.get({ ...params }) -> Report

Bytimes

Types:

• ByTime

Methods:

• client.dns.analytics.reports.bytimes.get({ ...params }) -> ByTime

ZoneTransfers

ForceAXFR

Types:

• ForceAXFR

Methods:

• client.dns.zoneTransfers.forceAXFR.create({ ...params }) -> ForceAXFR

Incoming

Types:

• Incoming
• IncomingCreateResponse
• IncomingUpdateResponse
• IncomingDeleteResponse
• IncomingGetResponse

Methods:

• client.dns.zoneTransfers.incoming.create({ ...params }) -> IncomingCreateResponse
• client.dns.zoneTransfers.incoming.update({ ...params }) -> IncomingUpdateResponse
• client.dns.zoneTransfers.incoming.delete({ ...params }) -> IncomingDeleteResponse
• client.dns.zoneTransfers.incoming.get({ ...params }) -> IncomingGetResponse

Outgoing

Types:

• DisableTransfer
• EnableTransfer
• Outgoing
• OutgoingStatus
• OutgoingCreateResponse
• OutgoingUpdateResponse
• OutgoingDeleteResponse
• OutgoingForceNotifyResponse
• OutgoingGetResponse

Methods:

• client.dns.zoneTransfers.outgoing.create({ ...params }) -> OutgoingCreateResponse
• client.dns.zoneTransfers.outgoing.update({ ...params }) -> OutgoingUpdateResponse
• client.dns.zoneTransfers.outgoing.delete({ ...params }) -> OutgoingDeleteResponse
• client.dns.zoneTransfers.outgoing.disable({ ...params }) -> DisableTransfer
• client.dns.zoneTransfers.outgoing.enable({ ...params }) -> EnableTransfer
• client.dns.zoneTransfers.outgoing.forceNotify({ ...params }) -> OutgoingForceNotifyResponse
• client.dns.zoneTransfers.outgoing.get({ ...params }) -> OutgoingGetResponse

Status

Methods:

• client.dns.zoneTransfers.outgoing.status.get({ ...params }) -> EnableTransfer

ACLs

Types:

• ACL
• ACLDeleteResponse

Methods:

• client.dns.zoneTransfers.acls.create({ ...params }) -> ACL
• client.dns.zoneTransfers.acls.update(aclId, { ...params }) -> ACL
• client.dns.zoneTransfers.acls.list({ ...params }) -> ACLsSinglePage
• client.dns.zoneTransfers.acls.delete(aclId, { ...params }) -> ACLDeleteResponse
• client.dns.zoneTransfers.acls.get(aclId, { ...params }) -> ACL

Peers

Types:

• Peer
• PeerDeleteResponse

Methods:

• client.dns.zoneTransfers.peers.create({ ...params }) -> Peer
• client.dns.zoneTransfers.peers.update(peerId, { ...params }) -> Peer
• client.dns.zoneTransfers.peers.list({ ...params }) -> PeersSinglePage
• client.dns.zoneTransfers.peers.delete(peerId, { ...params }) -> PeerDeleteResponse
• client.dns.zoneTransfers.peers.get(peerId, { ...params }) -> Peer

TSIGs

Types:

• TSIG
• TSIGDeleteResponse

Methods:

• client.dns.zoneTransfers.tsigs.create({ ...params }) -> TSIG
• client.dns.zoneTransfers.tsigs.update(tsigId, { ...params }) -> TSIG
• client.dns.zoneTransfers.tsigs.list({ ...params }) -> TSIGsSinglePage
• client.dns.zoneTransfers.tsigs.delete(tsigId, { ...params }) -> TSIGDeleteResponse
• client.dns.zoneTransfers.tsigs.get(tsigId, { ...params }) -> TSIG