Skip to main content
API docs by Redocly

DNS API (v2.0.0)

Managing DNS hosting zones and resource records (actual)

Zones

Create zone

header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "project_id": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "comment": "string",
  • "disabled": false,
  • "protected": false,
  • "delegation_checked_at": "string",
  • "last_delegated_at": "string",
  • "last_check_status": false
}

Get information about account zones

query Parameters
limit
integer (Limit) >= 1
Default: 1000
offset
integer (Offset) >= 0
Default: 0
filter
string (Filter)
Array of Sort By (strings) or Sort By (null) (Sort By)
Default: ""
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next_offset": 0,
  • "result": [
    ]
}

Delete zone

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

Get information about the specified zone

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "project_id": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "comment": "string",
  • "disabled": false,
  • "protected": false,
  • "delegation_checked_at": "string",
  • "last_delegated_at": "string",
  • "last_check_status": false
}

Update the comment of the specified zone

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
comment
required
string (Comment) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

Disable/enable zone maintenance

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
disabled
required
boolean (Disabled)

Responses

Request samples

Content type
application/json
{
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

Transfer zone to another project

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
project_id
required
string <uuid> (Project Id)

Responses

Request samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

Change the zone protection patch against deletion

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
protected
required
boolean (Protected)

Responses

Request samples

Content type
application/json
{
  • "protected": true
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

RRSets

Get information about zone record sets

path Parameters
zone_id
required
string <uuid> (Zone Id)
query Parameters
limit
integer (Limit) >= 1
Default: 1000
offset
integer (Offset) >= 0
Default: 0
sort_by
Array of strings (Sort By)
Default: ""
Items Enum: "type.ascend" "type.descend" "name.ascend" "name.descend"
rrset_types
Array of strings (Rrset Types)
name
string (Name)
search
string (Search)
managed_by
string <uuid> (Managed By)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next_offset": 0,
  • "result": [
    ]
}

Create record set

path Parameters
zone_id
required
string <uuid> (Zone Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Request Body schema: application/json
required
name
required
string (Name)
ttl
required
integer (Ttl) [ 60 .. 604800 ]
type
required
string (AllowedRecordTypes)
Enum: "A" "AAAA" "ALIAS" "CAA" "CNAME" "DNAME" "HTTPS" "MX" "NS" "SOA" "SRV" "SVCB" "SSHFP" "TXT"
required
Array of objects (Records) [ 1 .. 100 ] items
Comment (string) or Comment (null) (Comment)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ttl": 60,
  • "type": "A",
  • "records": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ttl": 0,
  • "type": "A",
  • "records": [
    ],
  • "comment": "string",
  • "managed_by": "d66b59ce-4322-4910-8d10-1d389ae8f1ba",
  • "zone_id": "4495020a-236f-46e0-9453-e3f9cc6476f4"
}

Delete record set

path Parameters
zone_id
required
string <uuid> (Zone Id)
rrset_id
required
string <uuid> (Rrset Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

X-Managed-By (string) or X-Managed-By (null) (X-Managed-By)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}

Get information about the specified record set

path Parameters
zone_id
required
string <uuid> (Zone Id)
rrset_id
required
string <uuid> (Rrset Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ttl": 0,
  • "type": "A",
  • "records": [
    ],
  • "comment": "string",
  • "managed_by": "d66b59ce-4322-4910-8d10-1d389ae8f1ba",
  • "zone_id": "4495020a-236f-46e0-9453-e3f9cc6476f4"
}

Update the specified record set

path Parameters
zone_id
required
string <uuid> (Zone Id)
rrset_id
required
string <uuid> (Rrset Id)
header Parameters
X-Auth-Token
string (X-Auth-Token)
Example: gAAAAABmokc_...

Keystone token for project

X-Managed-By (string) or X-Managed-By (null) (X-Managed-By)
Request Body schema: application/json
required
ttl
required
integer (Ttl) [ 60 .. 604800 ]
required
Array of objects (Records) [ 1 .. 100 ] items
Comment (string) or Comment (null) (Comment)

Responses

Request samples

Content type
application/json
{
  • "ttl": 60,
  • "records": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "description": "string",
  • "location": "string"
}