Zones

Endpoints related to zones

Retrieve zones

get

Returns a list of the DNS zones for the customer. Default limit is the first 100 items. Use pagination query parameters for listing more items (up to 1000).

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Query parameters

filter.statestring · enumOptional

The list of possible provisioning states in which DNS resource could be at the specific time.

• AVAILABLE - resource exists and is healthy.
• PROVISIONING - resource is being created or updated.
• DESTROYING - delete command was issued, the resource is being deleted.
• FAILED - creation of the resource failed.

Possible values:

filter.zoneNamestringOptional

Filter used to fetch only the zones that contain the specified zone name.

Example: example.com

offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100

Responses

200

Successful operation.

application/json

List of primary zones

idstring · uuidRequired

ID (UUID) created to identify this action.

Example: e74d0d15-f567-4b7b-9069-26ee1f93bae3

typestring · enumRequiredPossible values:

hrefstring · uriRead-onlyRequiredExample: <RESOURCE-URI>

offsetnumberRead-onlyRequired

Pagination offset.

Example: 0

limitnumberRead-onlyRequired

Pagination limit.

Example: 1000

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/zones

HTTPcURLJavaScriptPython

GET /zones HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  },
  "items": [
    {
      "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
      "type": "zone",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "createdDate": "2022-08-21T15:52:53Z",
        "createdBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2022-08-21T15:52:53Z",
        "lastModifiedBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "PROVISIONING",
        "nameservers": [
          "ns-ic.ui-dns.com",
          "ns-ic.ui-dns.de",
          "ns-ic.ui-dns.org",
          "ns-ic.ui-dns.biz"
        ]
      },
      "properties": {
        "zoneName": "example.com",
        "description": "The hosted zone is used for example.com",
        "enabled": true
      }
    }
  ]
}

Create a zone

post

Creates a new zone with default NS and SOA records.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Body

application/json

Responses

202

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

post

/zones

HTTPcURLJavaScriptPython

POST /zones HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "enabled": true
  }
}

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "zone",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "createdDate": "2022-08-21T15:52:53Z",
    "createdBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "lastModifiedBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "PROVISIONING",
    "nameservers": [
      "ns-ic.ui-dns.com",
      "ns-ic.ui-dns.de",
      "ns-ic.ui-dns.org",
      "ns-ic.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "enabled": true
  }
}

Retrieve a zone

get

Returns a DNS zone by given ID.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

200

Successful operation.

application/json

idstring · uuidRequired

The zone ID (UUID).

Example: e74d0d15-f567-4b7b-9069-26ee1f93bae3

typestring · enumRequiredPossible values:

hrefstring · uriRead-onlyRequiredExample: <RESOURCE-URI>

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/zones/{zoneId}

HTTPcURLJavaScriptPython

GET /zones/{zoneId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "zone",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "createdDate": "2022-08-21T15:52:53Z",
    "createdBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "lastModifiedBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "PROVISIONING",
    "nameservers": [
      "ns-ic.ui-dns.com",
      "ns-ic.ui-dns.de",
      "ns-ic.ui-dns.org",
      "ns-ic.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "enabled": true
  }
}

Update a zone

put

Updates or creates a zone for the provided zone ID.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Body

application/json

Responses

202

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

put

/zones/{zoneId}

HTTPcURLJavaScriptPython

PUT /zones/{zoneId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "enabled": true
  }
}

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "zone",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "createdDate": "2022-08-21T15:52:53Z",
    "createdBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "lastModifiedBy": "ionos:iam:cloud:31960002:users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "PROVISIONING",
    "nameservers": [
      "ns-ic.ui-dns.com",
      "ns-ic.ui-dns.de",
      "ns-ic.ui-dns.org",
      "ns-ic.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "enabled": true
  }
}

Delete a zone

delete

Deletes the specified zone and all of the records it contains.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

202

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

delete

/zones/{zoneId}

HTTPcURLJavaScriptPython

DELETE /zones/{zoneId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{}