PowerDNSAdvancedClient | @marxlnfcs/powerdns

Hierarchy

PowerDNSAdvancedClient

Constructors

constructor

new PowerDNSAdvancedClient(options: IPowerDNSOptions, selectedServer?: string): PowerDNSAdvancedClient

- Defined in client/advanced-client.ts:43
Constructor

Parameters
- options: IPowerDNSOptions
- selectedServer: string = 'localhost'
Returns PowerDNSAdvancedClient

Properties

Protected http

http: Axios = ...

Variables

Protected options

options: IPowerDNSOptions

Protected selectedServer

selectedServer: string = 'localhost'

Methods

addAutoPrimary

addAutoPrimary(dto: IPowerDNSAutoPrimaryServer): Promise<void>

- Defined in client/advanced-client.ts:680
Add an autoprimary server

description
This methods add a new autoprimary server.

see
https://doc.powerdns.com/authoritative/http-api/autoprimaries.html#post--servers-server_id-autoprimaries

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- dto: IPowerDNSAutoPrimaryServer
  
  Key to create
Returns Promise<void>
IPowerDNSTSIGKey

createCryptoKey

createCryptoKey(zoneId: string, dto?: IPowerDNSCryptoKeyCreate): Promise<IPowerDNSCryptoKey>

- Defined in client/advanced-client.ts:391
Creates a Cryptokey

description
This method adds a new key to a zone. The key can either be generated or imported by supplying the content parameter. if content, bits and algo are null, a key will be generated based on the default-ksk-algorithm and default-ksk-size settings for a KSK and the default-zsk-algorithm and default-zsk-size options for a ZSK.

see
https://doc.powerdns.com/authoritative/http-api/cryptokey.html#post--servers-server_id-zones-zone_id-cryptokeys

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- Optional dto: IPowerDNSCryptoKeyCreate
  
  The cryptoKey to create
Returns Promise<IPowerDNSCryptoKey>
IPowerDNSZone

createMetadata

createMetadata(zoneId: string, dto: IPowerDNSMetadataCreate): Promise<IPowerDNSMetadata>

- Defined in client/advanced-client.ts:495
Creates a set of metadata entries

see
https://doc.powerdns.com/authoritative/http-api/metadata.html#post--servers-server_id-zones-zone_id-metadata

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- dto: IPowerDNSMetadataCreate
  
  Set of metadata to create
Returns Promise<IPowerDNSMetadata>
IPowerDNSMetadata

createTSIGKey

createTSIGKey(dto: IPowerDNSTSIGKeyCreate): Promise<IPowerDNSTSIGKey>

- Defined in client/advanced-client.ts:598
Add a TSIG key

description
This methods add a new TSIGKey. The actual key can be generated by the server or be provided by the client

see
https://doc.powerdns.com/authoritative/http-api/tsigkey.html#post--servers-server_id-tsigkeys

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- dto: IPowerDNSTSIGKeyCreate
  
  Key to create
Returns Promise<IPowerDNSTSIGKey>
IPowerDNSTSIGKey

createZone

createZone(dto: IPowerDNSZoneCreate, options?: IPowerDNSHttpCreateZoneOptions): Promise<IPowerDNSZone>

- Defined in client/advanced-client.ts:210
Creates a new zone. Returns the Zone on creation.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#post--servers-server_id-zones

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- dto: IPowerDNSZoneCreate
  
  The zone to create
- Optional options: IPowerDNSHttpCreateZoneOptions
  
  Options for this request
Returns Promise<IPowerDNSZone>
IPowerDNSZone

deleteAutoPrimary

deleteAutoPrimary(ip: string, nameserver: string): Promise<void>

- Defined in client/advanced-client.ts:701
Delete the autoprimary entry

see
https://doc.powerdns.com/authoritative/http-api/autoprimaries.html#delete--servers-server_id-autoprimaries-ip-nameserver

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- ip: string
  
  IP address of autoprimary
- nameserver: string
  
  DNS name of the autoprimary
Returns Promise<void>
void

deleteCryptoKey

deleteCryptoKey(zoneId: string, cryptoKeyId: string): Promise<void>

- Defined in client/advanced-client.ts:433
This method deletes a key specified by cryptokey_id.

see
https://doc.powerdns.com/authoritative/http-api/cryptokey.html#delete--servers-server_id-zones-zone_id-cryptokeys-cryptokey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- cryptoKeyId: string
  
  The cryptoKey to retrieve
Returns Promise<void>
void

deleteMetadata

deleteMetadata(zoneId: string, metadataKind: string): Promise<void>

- Defined in client/advanced-client.ts:538
Delete all items of a single kind of domain metadata.

see
https://doc.powerdns.com/authoritative/http-api/metadata.html#delete--servers-server_id-zones-zone_id-metadata-metadata_kind

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- metadataKind: string
  
  The kind of the metadata to retrieve
Returns Promise<void>
void

deleteTSIGKey

deleteTSIGKey(keyId: string): Promise<void>

- Defined in client/advanced-client.ts:640
Delete the TSIGKey

see
https://doc.powerdns.com/authoritative/http-api/tsigkey.html#delete--servers-server_id-tsigkeys-tsigkey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- keyId: string
  
  The id of the key to retrieve
Returns Promise<void>
void

deleteZone

deleteZone(zoneId: string): Promise<void>

- Defined in client/advanced-client.ts:286
Deletes this zone, all attached metadata and rrsets.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#delete--servers-server_id-zones-zone_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The zone to update
Returns Promise<void>
void

exportZone

exportZone(zoneId: string): Promise<string>

- Defined in client/advanced-client.ts:168
Returns the zone in AXFR format.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#get--servers-server_id-zones-zone_id-export

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
Returns Promise<string>
string

flushCache

flushCache(domain: string): Promise<IPowerDNSCacheFlushResult>

- Defined in client/advanced-client.ts:762
Flush a cache-entry by name

see
https://doc.powerdns.com/authoritative/http-api/cache.html#put--servers-server_id-cache-flush

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domain: string
  
  The domain name to flush from cache
Returns Promise<IPowerDNSCacheFlushResult>
IPowerDNSCacheFlushResult

getAutoPrimaries

getAutoPrimaries(): Promise<IPowerDNSAutoPrimaryServer[]>

- Defined in client/advanced-client.ts:659
Get a list of autoprimary servers

see
https://doc.powerdns.com/authoritative/http-api/autoprimaries.html#get--servers-server_id-autoprimaries

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Returns Promise<IPowerDNSAutoPrimaryServer[]>
IPowerDNSAutoPrimaryServer[]

getConfigs

getConfigs(): Promise<IPowerDNSServerConfig[]>

- Defined in client/advanced-client.ts:107
Returns all configurations in the selected server

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Returns Promise<IPowerDNSServerConfig[]>
Promise<IPowerDNSServerConfig[]>

getCryptoKey

getCryptoKey(zoneId: string, cryptoKeyId: number): Promise<IPowerDNSCryptoKey>

- Defined in client/advanced-client.ts:369
Returns all data about the CryptoKey, including the privatekey.

see
https://doc.powerdns.com/authoritative/http-api/cryptokey.html#get--servers-server_id-zones-zone_id-cryptokeys-cryptokey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- cryptoKeyId: number
  
  The cryptoKey to retrieve
Returns Promise<IPowerDNSCryptoKey>
void

getCryptoKeys

getCryptoKeys(zoneId: string): Promise<IPowerDNSCryptoKey[]>

- Defined in client/advanced-client.ts:348
Get all CryptoKeys for a zone, except the privatekey

see
https://doc.powerdns.com/authoritative/http-api/cryptokey.html#get--servers-server_id-zones-zone_id-cryptokeys

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
Returns Promise<IPowerDNSCryptoKey[]>
void

getMetadata

getMetadata(zoneId: string): Promise<IPowerDNSMetadata[]>

- Defined in client/advanced-client.ts:453
Get all the Metadata associated with the zone.

see
https://doc.powerdns.com/authoritative/http-api/metadata.html#get--servers-server_id-zones-zone_id-metadata

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
Returns Promise<IPowerDNSMetadata[]>
IPowerDNSMetadata[]

getMetadataContents

getMetadataContents(zoneId: string, metadataKind: string): Promise<IPowerDNSMetadata>

- Defined in client/advanced-client.ts:474
Get the content of a single kind of domain metadata as a Metadata object.

see
https://doc.powerdns.com/authoritative/http-api/metadata.html#get--servers-server_id-zones-zone_id-metadata-metadata_kind

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- metadataKind: string
  
  The kind of the metadata to retrieve
Returns Promise<IPowerDNSMetadata>
IPowerDNSMetadata

getServer

getServer(serverId?: string): Promise<IPowerDNSServer>

- Defined in client/advanced-client.ts:89
Get a server

see
https://doc.powerdns.com/authoritative/http-api/server.html#get--servers-server_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- serverId: string = ...
  
  The id of the server to retrieve
Returns Promise<IPowerDNSServer>
Promise

getServers

getServers(): Promise<IPowerDNSServer[]>

- Defined in client/advanced-client.ts:69
List all servers

see
https://doc.powerdns.com/authoritative/http-api/server.html#get--servers

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Returns Promise<IPowerDNSServer[]>
Promise<IPowerDNSServer[]>

getStatistics

getStatistics(options?: IPowerDNSHttpGetStatisticsOptions): Promise<IPowerDNSStatistic[]>

- Defined in client/advanced-client.ts:742
Query PowerDNS internal statistics.

see
https://doc.powerdns.com/authoritative/http-api/statistics.html#get--servers-server_id-statistics

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- Optional options: IPowerDNSHttpGetStatisticsOptions
  
  The request options
Returns Promise<IPowerDNSStatistic[]>
IPowerDNSStatistic[]

getTSIGKey

getTSIGKey(keyId: string): Promise<IPowerDNSTSIGKey>

- Defined in client/advanced-client.ts:577
Get a specific TSIGKeys on the server, including the actual key

see
https://doc.powerdns.com/authoritative/http-api/tsigkey.html#get--servers-server_id-tsigkeys-tsigkey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- keyId: string
  
  The id of the key to retrieve
Returns Promise<IPowerDNSTSIGKey>
IPowerDNSTSIGKey

getTSIGKeys

getTSIGKeys(): Promise<IPowerDNSTSIGKeyItem[]>

- Defined in client/advanced-client.ts:557
Get all TSIGKeys on the server, except the actual key

see
https://doc.powerdns.com/authoritative/http-api/tsigkey.html#get--servers-server_id-tsigkeys

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Returns Promise<IPowerDNSTSIGKeyItem[]>
IPowerDNSTSIGKeyItem[]

getZone

getZone(zoneId: string, options?: IPowerDNSHttpGetZoneOptions): Promise<IPowerDNSZone>

- Defined in client/advanced-client.ts:148
Returns information in the selected zone

see
https://doc.powerdns.com/authoritative/http-api/zone.html#get--servers-server_id-zones-zone_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- Optional options: IPowerDNSHttpGetZoneOptions
  
  Options for this request
Returns Promise<IPowerDNSZone>
IPowerDNSZone

getZones

getZones(options?: IPowerDNSHttpGetZonesOptions): Promise<IPowerDNSZoneItem[]>

- Defined in client/advanced-client.ts:127
List all Zones in a server

see
https://doc.powerdns.com/authoritative/http-api/zone.html#get--servers-server_id-zones

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- Optional options: IPowerDNSHttpGetZonesOptions
  
  Options for this request
Returns Promise<IPowerDNSZoneItem[]>
Promise<IPowerDNSZone[]>

notifyAllSlaves

notifyAllSlaves(zoneId: string): Promise<void>

- Defined in client/advanced-client.ts:328
Send a DNS NOTIFY to all slaves.

description
Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT send a body.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#put--servers-server_id-zones-zone_id-notify

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The zone to update
Returns Promise<void>
void

rectifyZone

rectifyZone(zoneId: string): Promise<string>

- Defined in client/advanced-client.ts:189
Rectify the zone data.

description
This does not take into account the API-RECTIFY metadata. Fails on slave zones and zones that do not have DNSSEC.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#put--servers-server_id-zones-zone_id-rectify

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
Returns Promise<string>
string

retrieveSlaveFromMaster

retrieveSlaveFromMaster(zoneId: string): Promise<void>

- Defined in client/advanced-client.ts:307
Retrieve slave zone from its master.

description
Fails when zone kind is not Slave, or slave is disabled in the configuration. Clients MUST NOT send a body.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#put--servers-server_id-zones-zone_id-axfr-retrieve

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The zone to update
Returns Promise<void>
void

search

search(search: string, options?: IPowerDNSHttpSearchOptions): Promise<IPowerDNSSearchResult>

- Defined in client/advanced-client.ts:722
Search the data inside PowerDNS

see
https://doc.powerdns.com/authoritative/http-api/search.html#get--servers-server_id-search-data

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- search: string
  
  The string to search for
- Optional options: IPowerDNSHttpSearchOptions
  
  The request options
Returns Promise<IPowerDNSSearchResult>
IPowerDNSSearchResult

toggleCryptoKeyActiveState

toggleCryptoKeyActiveState(zoneId: string, cryptoKeyId: string): Promise<void>

- Defined in client/advanced-client.ts:412
This method (de)activates a key.

see
https://doc.powerdns.com/authoritative/http-api/cryptokey.html#put--servers-server_id-zones-zone_id-cryptokeys-cryptokey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- cryptoKeyId: string
  
  The cryptoKey to retrieve
Returns Promise<void>
void

updateMetadata

updateMetadata(zoneId: string, metadataKind: string, metadata: string | string[]): Promise<IPowerDNSMetadata>

- Defined in client/advanced-client.ts:517
Replace the content of a single kind of domain metadata.

see
https://doc.powerdns.com/authoritative/http-api/metadata.html#put--servers-server_id-zones-zone_id-metadata-metadata_kind

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The id of the zone to retrieve
- metadataKind: string
  
  The kind of the metadata to retrieve
- metadata: string | string[]
  
  Values to update
Returns Promise<IPowerDNSMetadata>
IPowerDNSMetadata

updateTSIGKey

updateTSIGKey(keyId: string, dto: IPowerDNSTSIGKeyUpdate): Promise<IPowerDNSTSIGKey>

- Defined in client/advanced-client.ts:620
Updates the specific TSIGKey on the server.

description
The TSIGKey at tsigkey_id can be changed in multiple ways: Changing the Name, this will remove the key with tsigkey_id after adding. Changing the Algorithm. Changing the Key.

see
https://doc.powerdns.com/authoritative/http-api/tsigkey.html#put--servers-server_id-tsigkeys-tsigkey_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- keyId: string
  
  The id of the key to retrieve
- dto: IPowerDNSTSIGKeyUpdate
  
  Values to update
Returns Promise<IPowerDNSTSIGKey>
IPowerDNSMetadata

updateZone

updateZone(zoneId: string, dto: IPowerDNSZoneUpdate): Promise<void>

- Defined in client/advanced-client.ts:232
Modifies basic zone data.

description
The only fields in the zone structure which can be modified are: kind, masters, account, soa_edit, soa_edit_api, api_rectify, dnssec, and nsec3param. All other fields are ignored.

see
https://doc.powerdns.com/authoritative/http-api/zone.html#put--servers-server_id-zones-zone_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The zone to update
- dto: IPowerDNSZoneUpdate
  
  Values to update
Returns Promise<void>
void

updateZoneRecords

updateZoneRecords(zoneId: string, records: IPowerDNSZoneRRSet[]): Promise<void>

- Defined in client/advanced-client.ts:253
Creates/modifies/deletes RRsets present in the payload and their comments

see
https://doc.powerdns.com/authoritative/http-api/zone.html#put--servers-server_id-zones-zone_id

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- zoneId: string
  
  The zone to update
- records: IPowerDNSZoneRRSet[]
Returns Promise<void>
void

useServer

useServer(serverId: string): PowerDNSAdvancedClient

- Defined in client/advanced-client.ts:54
Returns a new instance of the client for the selected server

Parameters
- serverId: string
Returns PowerDNSAdvancedClient
PowerDNSHttpClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IPowerDNSOptions

selectedServer: string = 'localhost'

Returns PowerDNSAdvancedClient

Properties

Protected http

Protected options

Protected selectedServer

Methods

addAutoPrimary

Parameters

dto: IPowerDNSAutoPrimaryServer

Returns Promise<void>

createCryptoKey

Parameters

zoneId: string

Optional dto: IPowerDNSCryptoKeyCreate

Returns Promise<IPowerDNSCryptoKey>

createMetadata

Parameters

zoneId: string

dto: IPowerDNSMetadataCreate

Returns Promise<IPowerDNSMetadata>

createTSIGKey

Parameters

dto: IPowerDNSTSIGKeyCreate

Returns Promise<IPowerDNSTSIGKey>

createZone

Parameters

dto: IPowerDNSZoneCreate

Optional options: IPowerDNSHttpCreateZoneOptions

Returns Promise<IPowerDNSZone>

deleteAutoPrimary

Parameters

ip: string

nameserver: string

Returns Promise<void>

deleteCryptoKey

Parameters

zoneId: string

cryptoKeyId: string

Returns Promise<void>

deleteMetadata

Parameters

zoneId: string

metadataKind: string

Returns Promise<void>

deleteTSIGKey

Parameters

keyId: string

Returns Promise<void>

deleteZone

Parameters

zoneId: string

Returns Promise<void>

exportZone

Parameters

zoneId: string

Returns Promise<string>

flushCache

Parameters

domain: string

Returns Promise<IPowerDNSCacheFlushResult>

getAutoPrimaries

Returns Promise<IPowerDNSAutoPrimaryServer[]>

getConfigs

Returns Promise<IPowerDNSServerConfig[]>

getCryptoKey

Parameters

zoneId: string

cryptoKeyId: number

Returns Promise<IPowerDNSCryptoKey>

getCryptoKeys