Domain

DNS zone management.

Read more

create-dns-domain

Create DNS domain

POST /dns-domain

Request body

Content-Type: application/json

PropertyTypeRequiredDescription
unicode-namestringnoDomain name
Example
{
  "unicode-name": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-dns-domain: golang | Python | Java

CLI: exo api create-dns-domain

get-dns-domain

Retrieve DNS domain details

GET /dns-domain/{id}

Path parameters

NameInDescription
idpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
created-atstringDNS domain creation date
idstringDNS domain ID
unicode-namestringDNS domain unicode name
Example output
{
  "created-at": "2024-01-01T12:00:00Z",
  "id": "string",
  "unicode-name": "string"
}

SDK reference for get-dns-domain: golang | Python | Java

CLI: exo api get-dns-domain

delete-dns-domain

Delete DNS Domain

DELETE /dns-domain/{id}

Path parameters

NameInDescription
idpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-dns-domain: golang | Python | Java

CLI: exo api delete-dns-domain


Other Operations

get-dns-domain-zone-file

Retrieve DNS domain zone file

GET /dns-domain/{id}/zone

Path parameters

NameInDescription
idpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
zone-filestring
Example output
{
  "zone-file": "string"
}

SDK reference for get-dns-domain-zone-file: golang | Python | Java

CLI: exo api get-dns-domain-zone-file

list-dns-domains

List DNS domains

GET /dns-domain

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
dns-domainsarray[object]schema details
Example output
{
  "dns-domains": [
    {
      "created-at": "2024-01-01T12:00:00Z",
      "id": "string",
      "unicode-name": "string"
    }
  ]
}

SDK reference for list-dns-domains: golang | Python | Java

CLI: exo api list-dns-domains

Last updated on