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

Records

Endpoints related to records

Retrieve records for a secondary zone

get

Returns the list of records for a secondary zone. Those are the records created for its primary IPs

Authorizations
Path parameters
secondaryZoneIdstring · uuidRequired

The ID (UUID) of the DNS secondary zone.

Query parameters
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
get
GET /secondaryzones/{secondaryZoneId}/records HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "42b21ce3-6fc7-44af-b0c9-2aaadbf2b333",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "primaryIps": [
      "1.2.3.4",
      "5.6.7.8"
    ]
  },
  "items": [
    {
      "type": "record",
      "metadata": {
        "fqdn": "app.example.com",
        "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf",
        "rootName": "primary-zone.de"
      },
      "properties": {
        "name": "app",
        "type": "A",
        "content": "1.2.3.4",
        "ttl": 3600,
        "priority": 3600,
        "enabled": true
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve all records from primary zones

get

Returns the list of all records for all customer DNS zones with the possibility to filter them.

Authorizations
Query parameters
filter.zoneIdstring · uuidOptional

Filter used to fetch only the records that contain specified zoneId.

Example: 1d6ca576-7162-4700-8df7-208bbe28fc44
filter.namestringOptional

Filter used to fetch only the records that contain specified record name.

Example: app
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.typestring · enumOptional

Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.

Possible values:
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
get
GET /records HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "42b21ce3-6fc7-44af-b0c9-2aaadbf2b333",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "90d81ac0-3a30-44d4-95a5-12959effa6ee",
      "type": "record",
      "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",
        "fqdn": "app.example.com",
        "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf"
      },
      "properties": {
        "name": "app",
        "type": "A",
        "content": "1.2.3.4",
        "ttl": 3600,
        "priority": 3600,
        "enabled": true
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve records

get

Returns the list of records for the specific DNS zone.

Authorizations
Path parameters
zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Responses
200
Successful operation.
application/json
get
GET /zones/{zoneId}/records HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "42b21ce3-6fc7-44af-b0c9-2aaadbf2b333",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "90d81ac0-3a30-44d4-95a5-12959effa6ee",
      "type": "record",
      "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",
        "fqdn": "app.example.com",
        "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf"
      },
      "properties": {
        "name": "app",
        "type": "A",
        "content": "1.2.3.4",
        "ttl": 3600,
        "priority": 3600,
        "enabled": true
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create a record

post

Creates a new record for the DNS zone.

Authorizations
Path parameters
zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

Body
Responses
202
Successful operation.
application/json
post
POST /zones/{zoneId}/records HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "properties": {
    "name": "",
    "type": "A",
    "content": "192.0.2.1",
    "ttl": 3600,
    "enabled": true
  }
}
{
  "id": "90d81ac0-3a30-44d4-95a5-12959effa6ee",
  "type": "record",
  "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",
    "fqdn": "app.example.com",
    "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf"
  },
  "properties": {
    "name": "app",
    "type": "A",
    "content": "1.2.3.4",
    "ttl": 3600,
    "priority": 3600,
    "enabled": true
  }
}

Retrieve a record

get

Returns the record with the specified record ID.

Authorizations
Path parameters
zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

recordIdstring · uuidRequired

The ID (UUID) of the record.

Responses
200
Successful operation.
application/json
get
GET /zones/{zoneId}/records/{recordId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "90d81ac0-3a30-44d4-95a5-12959effa6ee",
  "type": "record",
  "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",
    "fqdn": "app.example.com",
    "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf"
  },
  "properties": {
    "name": "app",
    "type": "A",
    "content": "1.2.3.4",
    "ttl": 3600,
    "priority": 3600,
    "enabled": true
  }
}

Update a record

put

Updates or creates a DNS record for the provided record ID.

Authorizations
Path parameters
zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

recordIdstring · uuidRequired

The ID (UUID) of the DNS record.

Body
Responses
202
Successful operation.
application/json
put
PUT /zones/{zoneId}/records/{recordId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "properties": {
    "name": "app",
    "type": "A",
    "content": "1.2.3.4",
    "ttl": 3600,
    "priority": 3600,
    "enabled": true
  }
}
{
  "id": "90d81ac0-3a30-44d4-95a5-12959effa6ee",
  "type": "record",
  "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",
    "fqdn": "app.example.com",
    "zoneId": "a363f30c-4c0c-4552-9a07-298d87f219bf"
  },
  "properties": {
    "name": "app",
    "type": "A",
    "content": "1.2.3.4",
    "ttl": 3600,
    "priority": 3600,
    "enabled": true
  }
}

Delete a record

delete

Deletes a specified record from the DNS zone.

Authorizations
Path parameters
zoneIdstring · uuidRequired

The ID (UUID) of the DNS zone.

recordIdstring · uuidRequired

The ID (UUID) of the record.

Responses
202
Successful operation.
application/json
Responseobject
delete
DELETE /zones/{zoneId}/records/{recordId} HTTP/1.1
Host: dns.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{}
PreviousSecondaryZonesNextZoneFiles

Was this helpful?