SecondaryZones

Endpoints related to secondary zones

Retrieve secondary zones

get

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

Authorizations

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

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

/secondaryzones

GET /secondaryzones 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",
        "primaryIps": [
          "1.2.3.4",
          "5.6.7.8"
        ]
      }
    }
  ]
}

Create a secondary zone

post

Creates a new secondary zone with default NS and SOA records. Note that Cloud DNS relies on the following Anycast addresses for sending DNS notify messages. Make sure to whitelist on your end:

IPv4: 212.227.123.25
IPv6: 2001:8d8:fe:53::5cd:25

Authorizations

AuthorizationstringRequired

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

Body

Responses

202

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

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

post

/secondaryzones

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

{
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  }
}

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "zone",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "createdDate": "2022-08-21T15:52:53Z",
    "state": "PROVISIONING",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "nameservers": [
      "nscs.ui-dns.com",
      "nscs.ui-dns.de",
      "nscs.ui-dns.org",
      "nscs.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  }
}

Retrieve a secondary zone

get

Returns a DNS secondary zone by given ID.

Authorizations

AuthorizationstringRequired

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

Path parameters

secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

200

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

get

/secondaryzones/{secondaryZoneId}

GET /secondaryzones/{secondaryZoneId} 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": {
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "createdDate": "2022-08-21T15:52:53Z",
    "state": "PROVISIONING",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "nameservers": [
      "nscs.ui-dns.com",
      "nscs.ui-dns.de",
      "nscs.ui-dns.org",
      "nscs.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  }
}

Update a secondary zone

put

Updates or creates a secondary zone for the provided secondary Zone ID.

Authorizations

AuthorizationstringRequired

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

Path parameters

secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Body

Responses

202

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

put

/secondaryzones/{secondaryZoneId}

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

{
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  }
}

{
  "id": "e74d0d15-f567-4b7b-9069-26ee1f93bae3",
  "type": "zone",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "createdDate": "2022-08-21T15:52:53Z",
    "state": "PROVISIONING",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "nameservers": [
      "nscs.ui-dns.com",
      "nscs.ui-dns.de",
      "nscs.ui-dns.org",
      "nscs.ui-dns.biz"
    ]
  },
  "properties": {
    "zoneName": "example.com",
    "description": "The hosted zone is used for example.com",
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  }
}

Delete a secondary zone

delete

Deletes the specified secondary zone.

Authorizations

AuthorizationstringRequired

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

Path parameters

secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

202

Successful operation.

application/json

objectOptional

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

/secondaryzones/{secondaryZoneId}

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

{}

Get status of zone transfer

get

Get status of zone transfer. Note that Cloud DNS relies on the following Anycast addresses for sending DNS notify messages. Make sure to whitelist on your end:

IPv4: 212.227.123.25
IPv6: 2001:8d8:fe:53::5cd:25

Authorizations

AuthorizationstringRequired

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

Path parameters

secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

202

Successful operation.

application/json

Indicates, for secondary zones, the transfer status for each one single IP defined on primaryIps field

typestring · enumRequiredPossible values:

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

/secondaryzones/{secondaryZoneId}/axfr

GET /secondaryzones/{secondaryZoneId}/axfr HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "type": "collection",
  "items": [
    {
      "primaryIp": "1.2.3.4",
      "status": "text",
      "errorMessage": "Connection with primary nameserver could not be   established"
    }
  ]
}

Start zone transfer

put

Initiate zone transfer. Note that Cloud DNS relies on the following Anycast addresses for sending DNS notify messages. Make sure to whitelist on your end:

IPv4: 212.227.123.25
IPv6: 2001:8d8:fe:53::5cd:25

Authorizations

AuthorizationstringRequired

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

Path parameters

secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses

202

Successful operation.

application/json

objectOptional

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

/secondaryzones/{secondaryZoneId}/axfr

PUT /secondaryzones/{secondaryZoneId}/axfr HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{}

PreviousZones NextRecords

Last updated 2 months ago

Was this helpful?

Good evening

hashtagRetrieve secondary zones

Bad Request

Unauthorized

Internal Server Error

hashtagCreate a secondary zone

Bad Request

Unauthorized

Not Allowed

Internal Server Error

hashtagRetrieve a secondary zone

Bad Request

Unauthorized

Not Allowed

Not Found

Internal Server Error

hashtagUpdate a secondary zone

Bad Request

Unauthorized

Not Allowed

Not Found

Internal Server Error

hashtagDelete a secondary zone

Bad Request

Unauthorized

Not Allowed

Not Found

Internal Server Error

hashtagGet status of zone transfer

Bad Request

Unauthorized

Not Allowed

Not Found

Internal Server Error

hashtagStart zone transfer

Bad Request

Unauthorized

Not Allowed

Not Found

Internal Server Error

Retrieve secondary zones

Create a secondary zone

Retrieve a secondary zone

Update a secondary zone

Delete a secondary zone

Get status of zone transfer

Start zone transfer