PowerDNSSimpleClient | @marxlnfcs/powerdns

Hierarchy

PowerDNSSimpleClient

Index

Constructors

constructor

Properties

baseClient

Methods

Constructors

constructor

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

- Defined in client/simple-client.ts:23
Constructor

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

Properties

Private baseClient

baseClient: PowerDNSAdvancedClient = ...

Base client

Methods

addRecord

addRecord(domainName: string, record: IPowerDNSSimpleRecordWrite): Promise<void>

- Defined in client/simple-client.ts:216
Add a record to the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- record: IPowerDNSSimpleRecordWrite
  
  Record to add
Returns Promise<void>
void

addRecords

addRecords(domainName: string, records: IPowerDNSSimpleRecordWrite[]): Promise<void>

- Defined in client/simple-client.ts:232
Adds multiple records to the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- records: IPowerDNSSimpleRecordWrite[]
  
  Array of records to add
Returns Promise<void>
void

createDomain

createDomain(domainName: string, kind?: IPowerDNSZoneKind): Promise<IPowerDNSZone>

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

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- kind: IPowerDNSZoneKind = 'Native'
  
  Kind of the domain
Returns Promise<IPowerDNSZone>
IPowerDNSZone

deleteDomain

deleteDomain(domainName: string): Promise<void>

- Defined in client/simple-client.ts:120
Deletes this domain, all attached metadata and rrsets.

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
Returns Promise<void>
void

findRecords

findRecords(domainName: string, type: string, name?: string): Promise<IPowerDNSSimpleRecord[]>

- Defined in client/simple-client.ts:181
Returns the searched record if exists

Parameters
- domainName: string
- type: string
- Optional name: string
Returns Promise<IPowerDNSSimpleRecord[]>

getDomain

getDomain(domainName: string, options?: IPowerDNSHttpGetZoneOptions): Promise<IPowerDNSZone>

- Defined in client/simple-client.ts:66
Returns information in the selected domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- Optional options: IPowerDNSHttpGetZoneOptions
  
  Options for this request
Returns Promise<IPowerDNSZone>
IPowerDNSZone

getDomains

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

- Defined in client/simple-client.ts:50
List all domains 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[]>

getRecords

getRecords(domainName: string): Promise<IPowerDNSSimpleRecord[]>

- Defined in client/simple-client.ts:135
Returns all records in this domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
Returns Promise<IPowerDNSSimpleRecord[]>
IPowerDNSZoneRRSet[]

hasDomain

hasDomain(domainName: string): Promise<boolean>

- Defined in client/simple-client.ts:83
Returns true if the server has the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
Returns Promise<boolean>

hasRecord

hasRecord(domainName: string, recordType: string, recordName?: string): Promise<boolean>

- Defined in client/simple-client.ts:161
Returns true if the zone has one record with the specified conditions

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- recordType: string
  
  Type of the record (e.g. "A", "MX")
- Optional recordName: string
  
  Name of the record
Returns Promise<boolean>

removeRecord

removeRecord(domainName: string, record: Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment">): Promise<void>

- Defined in client/simple-client.ts:361
Removes one record from the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- record: Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment">
  
  Record to add
Returns Promise<void>
void

removeRecords

removeRecords(domainName: string, records: (Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment" | "content"> & { content?: string | string[] })[]): Promise<void>

- Defined in client/simple-client.ts:377
Removes multiple records from the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- records: (Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment" | "content"> & { content?: string | string[] })[]
  
  Array of records to remove
Returns Promise<void>
void

setRecord

setRecord(domainName: string, record: IPowerDNSSimpleRecordWrite): Promise<void>

- Defined in client/simple-client.ts:296
Replaces all records with the specific name with the new one

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- record: IPowerDNSSimpleRecordWrite
  
  Record to add
Returns Promise<void>
void

setRecords

setRecords(domainName: string, records: IPowerDNSSimpleRecordWrite[]): Promise<void>

- Defined in client/simple-client.ts:312
Replaces all records with de records collection

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- domainName: string
  
  Name of the domain
- records: IPowerDNSSimpleRecordWrite[]
  
  Array of records to add
Returns Promise<void>
void

setupDomain

setupDomain(options: SimpleSetupOptions): Promise<true>

- Defined in client/simple-client.ts:439
Removes multiple records from the specified domain

throws
PowerDNSBadRequestException

throws
PowerDNSNotFoundException

throws
PowerDNSTimeoutException

throws
PowerDNSUnprocessableEntityException

throws
PowerDNSInternalServerErrorException

Parameters
- options: SimpleSetupOptions
  
  Options for the creation
Returns Promise<true>
void

useServer

useServer(serverId: string): PowerDNSSimpleClient

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

Parameters
- serverId: string
Returns PowerDNSSimpleClient
PowerDNSAuthoritativeClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IPowerDNSOptions

selectedServer: string = 'localhost'

Returns PowerDNSSimpleClient

Properties

Private baseClient

Methods

addRecord

Parameters

domainName: string

record: IPowerDNSSimpleRecordWrite

Returns Promise<void>

addRecords

Parameters

domainName: string

records: IPowerDNSSimpleRecordWrite[]

Returns Promise<void>

createDomain

Parameters

domainName: string

kind: IPowerDNSZoneKind = 'Native'

Returns Promise<IPowerDNSZone>

deleteDomain

Parameters

domainName: string

Returns Promise<void>

findRecords

Parameters

domainName: string

type: string

Optional name: string

Returns Promise<IPowerDNSSimpleRecord[]>

getDomain

Parameters

domainName: string

Optional options: IPowerDNSHttpGetZoneOptions

Returns Promise<IPowerDNSZone>

getDomains

Parameters

Optional options: IPowerDNSHttpGetZonesOptions

Returns Promise<IPowerDNSZoneItem[]>

getRecords

Parameters

domainName: string

Returns Promise<IPowerDNSSimpleRecord[]>

hasDomain

Parameters

domainName: string

Returns Promise<boolean>

hasRecord

Parameters

domainName: string

recordType: string

Optional recordName: string

Returns Promise<boolean>

removeRecord

Parameters

domainName: string

record: Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment">

Returns Promise<void>

removeRecords

Parameters

domainName: string

records: (Omit<IPowerDNSSimpleRecord, "disabled" | "ttl" | "comment" | "content"> & { content?: string | string[] })[]

Returns Promise<void>

setRecord

Parameters

domainName: string

record: IPowerDNSSimpleRecordWrite

Returns Promise<void>

setRecords

Parameters

domainName: string