Class API

Domains and DNS API.

This API allows you to manage your domains, DNS zones and records.

Hierarchy

API
- API

Constructors

constructor

new API(client): Domain.v2beta1.API
Parameters
- client: Client
Returns Domain.v2beta1.API
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

clearDNSZoneRecords

clearDNSZoneRecords(request): Promise<ClearDNSZoneRecordsResponse>
Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers.
All edits will be versioned.
Parameters
- request: Readonly<ClearDNSZoneRecordsRequest>
  The request ClearDNSZoneRecordsRequest
Returns Promise<ClearDNSZoneRecordsResponse>
A Promise of ClearDNSZoneRecordsResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:396

cloneDNSZone

cloneDNSZone(request): Promise<DNSZone>
Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone.
Parameters
- request: Readonly<CloneDNSZoneRequest>
  The request CloneDNSZoneRequest
Returns Promise<DNSZone>
A Promise of DNSZone
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:252

createDNSZone

createDNSZone(request): Promise<DNSZone>
Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID.
Parameters
- request: Readonly<CreateDNSZoneRequest>
  The request CreateDNSZoneRequest
Returns Promise<DNSZone>
A Promise of DNSZone
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:213

createSSLCertificate

createSSLCertificate(request): Promise<SSLCertificate>
Create or get the DNS zone's TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate.
Parameters
- request: Readonly<CreateSSLCertificateRequest>
  The request CreateSSLCertificateRequest
Returns Promise<SSLCertificate>
A Promise of SSLCertificate
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:623

deleteDNSZone

deleteDNSZone(request): Promise<DeleteDNSZoneResponse>
Delete a DNS zone. Delete a DNS zone and all its records.
Parameters
- request: Readonly<DeleteDNSZoneRequest>
  The request DeleteDNSZoneRequest
Returns Promise<DeleteDNSZoneResponse>
A Promise of DeleteDNSZoneResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:271

deleteDNSZoneTsigKey

deleteDNSZoneTsigKey(request): Promise<void>
Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
Parameters
- request: Readonly<DeleteDNSZoneTsigKeyRequest>
  The request DeleteDNSZoneTsigKeyRequest
Returns Promise<void>
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:705

deleteSSLCertificate

deleteSSLCertificate(request): Promise<DeleteSSLCertificateResponse>
Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone.
Parameters
- request: Readonly<DeleteSSLCertificateRequest>
  The request DeleteSSLCertificateRequest
Returns Promise<DeleteSSLCertificateResponse>
A Promise of DeleteSSLCertificateResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:674

exportRawDNSZone

exportRawDNSZone(request): Promise<Blob>
Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format.
Parameters
- request: Readonly<ExportRawDNSZoneRequest>
  The request ExportRawDNSZoneRequest
Returns Promise<Blob>
A Promise of Blob
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:412

getDNSZoneTsigKey

getDNSZoneTsigKey(request): Promise<GetDNSZoneTsigKeyResponse>
Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests.
Parameters
- request: Readonly<GetDNSZoneTsigKeyRequest>
  The request GetDNSZoneTsigKeyRequest
Returns Promise<GetDNSZoneTsigKeyResponse>
A Promise of GetDNSZoneTsigKeyResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:690

getDNSZoneVersionDiff

getDNSZoneVersionDiff(request): Promise<GetDNSZoneVersionDiffResponse>
Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version.
Parameters
- request: Readonly<GetDNSZoneVersionDiffRequest>
  The request GetDNSZoneVersionDiffRequest
Returns Promise<GetDNSZoneVersionDiffResponse>
A Promise of GetDNSZoneVersionDiffResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:551

getSSLCertificate

getSSLCertificate(request): Promise<SSLCertificate>
Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns no certificate found.
Parameters
- request: Readonly<GetSSLCertificateRequest>
  The request GetSSLCertificateRequest
Returns Promise<SSLCertificate>
A Promise of SSLCertificate
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:585

importProviderDNSZone

importProviderDNSZone(request): Promise<ImportProviderDNSZoneResponse>
Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers.
Parameters
- request: Readonly<ImportProviderDNSZoneRequest>
  The request ImportProviderDNSZoneRequest
Returns Promise<ImportProviderDNSZoneResponse>
A Promise of ImportProviderDNSZoneResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:447

importRawDNSZone

importRawDNSZone(request): Promise<ImportRawDNSZoneResponse>
Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers.
Parameters
- request: Readonly<ImportRawDNSZoneRequest>
  The request ImportRawDNSZoneRequest
Returns Promise<ImportRawDNSZoneResponse>
A Promise of ImportRawDNSZoneResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:427

listDNSZoneNameservers

listDNSZoneNameservers(request): Promise<ListDNSZoneNameserversResponse>
List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records.
Parameters
- request: Readonly<ListDNSZoneNameserversRequest>
  The request ListDNSZoneNameserversRequest
Returns Promise<ListDNSZoneNameserversResponse>
A Promise of ListDNSZoneNameserversResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:357

listDNSZoneRecords

listDNSZoneRecords(request): Promise<ListDNSZoneRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}
List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name.
Parameters
- request: Readonly<ListDNSZoneRecordsRequest>
  The request ListDNSZoneRecordsRequest
Returns Promise<ListDNSZoneRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}
A Promise of ListDNSZoneRecordsResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:315

listDNSZoneVersionRecords

listDNSZoneVersionRecords(request): Promise<ListDNSZoneVersionRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}
List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version.
Parameters
- request: Readonly<ListDNSZoneVersionRecordsRequest>
  The request ListDNSZoneVersionRecordsRequest
Returns Promise<ListDNSZoneVersionRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}
A Promise of ListDNSZoneVersionRecordsResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:535

listDNSZoneVersions

listDNSZoneVersions(request): Promise<ListDNSZoneVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZoneVersion[], void, void>);
all: (() => Promise<DNSZoneVersion[]>);
}
List versions of a DNS zone. Retrieve a list of a DNS zone's versions.
The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification.
Parameters
- request: Readonly<ListDNSZoneVersionsRequest>
  The request ListDNSZoneVersionsRequest
Returns Promise<ListDNSZoneVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZoneVersion[], void, void>);
all: (() => Promise<DNSZoneVersion[]>);
}
A Promise of ListDNSZoneVersionsResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:507

listDNSZones

listDNSZones(request): Promise<ListDNSZonesResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZone[], void, void>);
all: (() => Promise<DNSZone[]>);
}
List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names.
Parameters
- request: Readonly<ListDNSZonesRequest>
  The request ListDNSZonesRequest
Returns Promise<ListDNSZonesResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZone[], void, void>);
all: (() => Promise<DNSZone[]>);
}
A Promise of ListDNSZonesResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:203

listSSLCertificates

listSSLCertificates(request): Promise<ListSSLCertificatesResponse> & {
[asyncIterator]: (() => AsyncGenerator<SSLCertificate[], void, void>);
all: (() => Promise<SSLCertificate[]>);
}
List a user's TLS certificates. List all the TLS certificates a user has created, specified by the user's Project ID and the DNS zone.
Parameters
- request: Readonly<ListSSLCertificatesRequest>
  The request ListSSLCertificatesRequest
Returns Promise<ListSSLCertificatesResponse> & {
[asyncIterator]: (() => AsyncGenerator<SSLCertificate[], void, void>);
all: (() => Promise<SSLCertificate[]>);
}
A Promise of ListSSLCertificatesResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:663

refreshDNSZone

refreshDNSZone(request): Promise<RefreshDNSZoneResponse>
Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial. You can recreate the given DNS zone and its sub DNS zone if needed.
Parameters
- request: Readonly<RefreshDNSZoneRequest>
  The request RefreshDNSZoneRequest
Returns Promise<RefreshDNSZoneResponse>
A Promise of RefreshDNSZoneResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:468

restoreDNSZoneVersion

restoreDNSZoneVersion(request): Promise<RestoreDNSZoneVersionResponse>
Restore a DNS zone version. Restore and activate a version of a specific DNS zone.
Parameters
- request: Readonly<RestoreDNSZoneVersionRequest>
  The request RestoreDNSZoneVersionRequest
Returns Promise<RestoreDNSZoneVersionResponse>
A Promise of RestoreDNSZoneVersionResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:567

updateDNSZone

updateDNSZone(request): Promise<DNSZone>
Update a DNS zone. Update the name and/or the Organizations for a DNS zone.
Parameters
- request: Readonly<UpdateDNSZoneRequest>
  The request UpdateDNSZoneRequest
Returns Promise<DNSZone>
A Promise of DNSZone
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:232

updateDNSZoneNameservers

updateDNSZoneNameservers(request): Promise<UpdateDNSZoneNameserversResponse>
Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records.
Parameters
- request: Readonly<UpdateDNSZoneNameserversRequest>
  The request UpdateDNSZoneNameserversRequest
Returns Promise<UpdateDNSZoneNameserversResponse>
A Promise of UpdateDNSZoneNameserversResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:374

updateDNSZoneRecords

updateDNSZoneRecords(request): Promise<UpdateDNSZoneRecordsResponse>
Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.

Actions include:
- Add: allows you to add a new record or add a new IP to an existing A record, for example
- Set: allows you to edit a record or edit an IP from an existing A record, for example
- Delete: allows you to delete a record or delete an IP from an existing A record, for example
- Clear: allows you to delete all records from a DNS zone
All edits will be versioned.
Parameters
- request: Readonly<UpdateDNSZoneRecordsRequest>
  The request UpdateDNSZoneRecordsRequest
Returns Promise<UpdateDNSZoneRecordsResponse>
A Promise of UpdateDNSZoneRecordsResponse
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:337

waitForSSLCertificate

waitForSSLCertificate(request, options?): Promise<SSLCertificate>
Waits for SSLCertificate to be in a final state.
Parameters
- request: Readonly<GetSSLCertificateRequest>
  The request GetSSLCertificateRequest
- Optionaloptions: Readonly<WaitForOptions<SSLCertificate>>
  The waiting options
Returns Promise<SSLCertificate>
A Promise of SSLCertificate
- Defined in packages/clients/src/api/domain/v2beta1/api.gen.ts:601

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Domain.v2beta1.API

Methods

clearDNSZoneRecords

Parameters

Returns Promise<ClearDNSZoneRecordsResponse>

cloneDNSZone

Parameters

Returns Promise<DNSZone>

createDNSZone

Parameters

Returns Promise<DNSZone>

createSSLCertificate

Parameters

Returns Promise<SSLCertificate>

deleteDNSZone

Parameters

Returns Promise<DeleteDNSZoneResponse>

deleteDNSZoneTsigKey

Parameters

Returns Promise<void>

deleteSSLCertificate

Parameters

Returns Promise<DeleteSSLCertificateResponse>

exportRawDNSZone

Parameters

Returns Promise<Blob>

getDNSZoneTsigKey

Parameters

Returns Promise<GetDNSZoneTsigKeyResponse>

getDNSZoneVersionDiff

Parameters

Returns Promise<GetDNSZoneVersionDiffResponse>

getSSLCertificate

Parameters

Returns Promise<SSLCertificate>

importProviderDNSZone

Parameters

Returns Promise<ImportProviderDNSZoneResponse>

importRawDNSZone

Parameters

Returns Promise<ImportRawDNSZoneResponse>

listDNSZoneNameservers

Parameters

Returns Promise<ListDNSZoneNameserversResponse>

listDNSZoneRecords

Parameters

Returns Promise<ListDNSZoneRecordsResponse> & { [asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>); all: (() => Promise<DomainRecord[]>); }

listDNSZoneVersionRecords

Parameters

Returns Promise<ListDNSZoneVersionRecordsResponse> & { [asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>); all: (() => Promise<DomainRecord[]>); }

listDNSZoneVersions

Parameters

Returns Promise<ListDNSZoneVersionsResponse> & { [asyncIterator]: (() => AsyncGenerator<DNSZoneVersion[], void, void>); all: (() => Promise<DNSZoneVersion[]>); }

listDNSZones

Parameters

Returns Promise<ListDNSZonesResponse> & { [asyncIterator]: (() => AsyncGenerator<DNSZone[], void, void>); all: (() => Promise<DNSZone[]>); }

listSSLCertificates

Parameters

Returns Promise<ListSSLCertificatesResponse> & { [asyncIterator]: (() => AsyncGenerator<SSLCertificate[], void, void>); all: (() => Promise<SSLCertificate[]>); }

refreshDNSZone

Parameters

Returns Promise<RefreshDNSZoneResponse>

restoreDNSZoneVersion

Parameters

Returns Promise<RestoreDNSZoneVersionResponse>

updateDNSZone

Parameters

Returns Promise<DNSZone>

updateDNSZoneNameservers

Parameters

Returns Promise<UpdateDNSZoneNameserversResponse>

updateDNSZoneRecords

Returns Promise<ListDNSZoneRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}

Returns Promise<ListDNSZoneVersionRecordsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DomainRecord[], void, void>);
all: (() => Promise<DomainRecord[]>);
}

Returns Promise<ListDNSZoneVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZoneVersion[], void, void>);
all: (() => Promise<DNSZoneVersion[]>);
}

Returns Promise<ListDNSZonesResponse> & {
[asyncIterator]: (() => AsyncGenerator<DNSZone[], void, void>);
all: (() => Promise<DNSZone[]>);
}

Returns Promise<ListSSLCertificatesResponse> & {
[asyncIterator]: (() => AsyncGenerator<SSLCertificate[], void, void>);
all: (() => Promise<SSLCertificate[]>);
}