Domain

The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources.

POST

List Ingresses compatible with a certificate.

/v2/actions/list-ingresses-compatible-with-certificate/

DELETE

Delete a CertificateRequest.

/v2/certificate-request/{certificateRequestId}/

GET

List CertificateRequests belonging to a Project or an Ingress.

/v2/certificate-requests/

POST

Create a CertificateRequest.

/v2/certificate-requests/

GET

Get a CertificateRequest.

/v2/certificate-requests/{certificateRequestId}/

DELETE

Delete a Certificate.

/v2/certificate/{certificateId}/

GET

List Certificates belonging to a Project or an Ingress.

/v2/certificates/

GET

Get a Certificate.

/v2/certificates/{certificateId}/

PUT

Update a Certificate.

/v2/certificates/{certificateId}/

POST

Check the replacement of a Certificate.

/v2/certificates/{certificateId}/actions/check-replace-certificate/

POST

Create a DNSZone.

/v2/dns-zones/

GET

Get a DNSZone.

/v2/dns-zones/{dnsZoneId}/

DELETE

Delete a DNSZone.

/v2/dns-zones/{dnsZoneId}/

PUT

Update a record set on a DNSZone.

/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/

POST

Set a record set on a DNSZone to managed.

/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/actions/set-managed/

PUT

updates a-records for a specific zone

/v2/dns/zones/{zoneId}/recordset/acombined/custom/

deprecated!

POST

set a-records managed by ingress for a specific zone

/v2/dns/zones/{zoneId}/recordset/acombined/managed/ingress/

deprecated!

PUT

updates cname-record for a specific zone

/v2/dns/zones/{zoneId}/recordset/cname/

deprecated!

PUT

updates mx-records for a specific zone

/v2/dns/zones/{zoneId}/recordset/mx/custom/

deprecated!

POST

sets mx-records to managed for a specific zone

/v2/dns/zones/{zoneId}/recordset/mx/managed/

deprecated!

PUT

updates srv-records for a specific zone

/v2/dns/zones/{zoneId}/recordset/srv/

deprecated!

PUT

updates txt-records for a specific zone

/v2/dns/zones/{zoneId}/recordset/txt/

deprecated!

POST

Check if a Domain is available to register.

/v2/domain-registrable/

GET

Suggest a list of domains based on a prompt using AI.

/v2/domain-suggestions/

GET

List TLDs.

/v2/domain-tlds/

GET

List the contact schemas for a TLD.

/v2/domain-tlds/{tld}/contact-schemas/

POST

Check if a Domain is available to transfer.

/v2/domain-transferable/

GET

List Domains

/v2/domains/

POST

Check if a Domain is available to register.

/v2/domains/

deprecated!

GET

Get a Domain.

/v2/domains/{domainId}/

DELETE

Delete a Domain.

/v2/domains/{domainId}/

POST

Create an auth code for a Domains transfer-out process.

/v2/domains/{domainId}/actions/auth-code/

POST

Resend a Domain email.

/v2/domains/{domainId}/actions/resend-email/

PATCH

Update the auth code of a Domain.

/v2/domains/{domainId}/auth-code/

PATCH

Update a contact of a Domain.

/v2/domains/{domainId}/contacts/{contact}/

DELETE

Abort a Domain declaration.

/v2/domains/{domainId}/declaration/

PUT

Update an AuthCode.

/v2/domains/{domainId}/declarations/authcode/

deprecated!

PUT

Update a Domain's OwnerC handle.

/v2/domains/{domainId}/declarations/handles/

deprecated!

PUT

Change the owner contact of a domain.

/v2/domains/{domainId}/handles/ownerc/

deprecated!

GET

Get the latest screenshot's FileReference belonging to a Domain.

/v2/domains/{domainId}/latest-screenshot/

PUT

Change all nameservers of a Domain.

/v2/domains/{domainId}/nameservers/

deprecated!

PATCH

Update the nameservers of a Domain.

/v2/domains/{domainId}/nameservers/

PATCH

Update a Domain's project id.

/v2/domains/{domainId}/project-id/

PUT

Change the Project relation of a Domain.

/v2/domains/{domainId}/projectId/

deprecated!

GET

Get File Service Reference for a Screenshot of a domain.

/v2/domains/{domainId}/screenshots/newest/

deprecated!

GET

Get a HandleSchema.

/v2/domains/handle-schema/{domainName}/

deprecated!

GET

List Ingresses.

/v2/ingresses/

POST

Create an Ingress.

/v2/ingresses/

GET

Get an Ingress.

/v2/ingresses/{ingressId}/

DELETE

Delete an Ingress.

/v2/ingresses/{ingressId}/

POST

Request the ACME certificate issuance of an Ingress.

/v2/ingresses/{ingressId}/actions/request-acme-certificate-issuance/

POST

Verifiy the ownership of an Ingress.

/v2/ingresses/{ingressId}/actions/verify-ownership/

PUT

Update an Ingresses paths.

/v2/ingresses/{ingressId}/paths/

deprecated!

PATCH

Update the paths of an Ingress.

/v2/ingresses/{ingressId}/paths/

PUT

Update an Ingresses tls settings.

/v2/ingresses/{ingressId}/tls/

deprecated!

PATCH

Update the tls settings of an Ingress.

/v2/ingresses/{ingressId}/tls/

GET

List DNSZones belonging to a Project.

/v2/projects/{projectId}/dns-zones/

GET

List Domains belonging to a Project.

/v2/projects/{projectId}/domains/

deprecated!

GET

List Ingresses belonging to a project.

/v2/projects/{projectId}/ingresses/

deprecated!