AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

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
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
Responseall of
and
get
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
Body
propertiesall ofRequired
and
Responses
202
Successful operation.
application/json
Responseall ofExample: {"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"]}}
post
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
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses
200
Successful operation.
application/json
Responseall ofExample: {"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"]}}
get
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
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Body
propertiesall ofRequired
and
Responses
202
Successful operation.
application/json
Responseall ofExample: {"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"]}}
put
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
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses
202
Successful operation.
application/json
Responseobject
delete
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
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses
202
Successful operation.
application/json
get
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
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses
202
Successful operation.
application/json
Responseobject
put
PUT /secondaryzones/{secondaryZoneId}/axfr HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{}
PreviousZonesNextRecords

Was this helpful?