Private DNS API (1.0)

Managing DNS for private networks: DNS services, zones, and their record sets

Services

A service represents a connection to a DNS resolver.

List services

Returns a list of DNS services.

Authorizations:

iam_token_project_scoped

query Parameters

project

string

Example: project=0ef1e88209d84d9b943e655b5076f6a8

Filter results by project identifier.

Responses

Response samples

200
401
403

Content type

application/json

{"services": [{"id": "string",
"project": "string",
"network_id": "b706af9b-b048-42a5-a87d-d69a601abec8",
"high_availability": true
}
]
}

Create service

Create a new DNS service.

Authorizations:

iam_token_project_scoped

Request Body schema: application/json

network_id

required

string <uuid> (networkIdField)

Network identifier of the DNS service.

Responses

Request samples

Payload

Content type

application/json

{"network_id": "b706af9b-b048-42a5-a87d-d69a601abec8"
}

Response samples

201
400
401
403

Content type

application/json

{"service": {"id": "string",
"project": "string",
"network_id": "b706af9b-b048-42a5-a87d-d69a601abec8",
"high_availability": true,
"addresses": [{"address": "192.168.0.1",
"cidr": "192.168.0.0/24"
}
]
}
}

Get service information

Returns detailed information about the DNS service.

Authorizations:

iam_token_project_scoped

path Parameters

service_id

required

string <uuid>

Example: ba859349-b3f1-4015-9d0d-6871f7fadca7

DNS service identifier.

Responses

Response samples

200
401
403
404

Content type

application/json

{"service": {"id": "string",
"project": "string",
"network_id": "b706af9b-b048-42a5-a87d-d69a601abec8",
"high_availability": true,
"addresses": [{"address": "192.168.0.1",
"cidr": "192.168.0.0/24"
}
]
}
}

Delete service

Delete a DNS service.

Authorizations:

iam_token_project_scoped

path Parameters

service_id

required

string <uuid>

Example: ba859349-b3f1-4015-9d0d-6871f7fadca7

DNS service identifier.

Responses

Response samples

401
403
404

Content type

application/json

{"code": 0,
"message": "string"
}

Zones

List zones

Returns a list of zones.

Authorizations:

iam_token_project_scoped

query Parameters

project	string Example: project=0ef1e88209d84d9b943e655b5076f6a8 Filter results by project identifier.
domain	string Example: domain=domain.com Filter results by zone domain name.

Responses

Response samples

200
401
403

Content type

application/json

{"zones": [{"id": "string",
"name": "string",
"domain": "domain.com",
"project": "string",
"reserved_by": "string",
"ttl": 0,
"serial_number": 0
}
]
}

Create zone

Create a new private zone.

Authorizations:

iam_token_project_scoped

Request Body schema: application/json

name required	string (zoneNameField) <= 64 characters Name of the zone.
domain required	string (zoneDomainField) <= 255 characters Domain of the zone.
ttl	integer (zoneTTLField) >= 0 Default time-to-live (TTL) in the zone, in seconds.
	Array of objects (recordSetAddBody) <= 100 items List of record sets in the zone.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"domain": "domain.com",
"ttl": 0,
"records": [{"type": "A",
"domain": "sub.domain.com.",
"ttl": -1,
"values": ["string"
]
}
]
}

Response samples

201
400
401
403

Content type

application/json

{"zone": {"id": "string",
"name": "string",
"domain": "domain.com",
"project": "string",
"reserved_by": "string",
"ttl": 0,
"serial_number": 0,
"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
],
"bindings": [{"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"resource_type": "string"
}
]
}
}

Get zone information

Returns detailed information about a private zone.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Responses

Response samples

200
401
403
404

Content type

application/json

{"zone": {"id": "string",
"name": "string",
"domain": "domain.com",
"project": "string",
"reserved_by": "string",
"ttl": 0,
"serial_number": 0,
"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
],
"bindings": [{"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"resource_type": "string"
}
]
}
}

Update zone

Apply new parameters (name, TTL) or update existing ones for a private zone.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Request Body schema: application/json

name	string (zoneNameField) <= 64 characters Name of the zone.
ttl	integer (zoneTTLField) >= 0 Default time-to-live (TTL) in the zone, in seconds.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"ttl": 0
}

Response samples

200
400
401
403
404

Content type

application/json

{"zone": {"id": "string",
"name": "string",
"domain": "domain.com",
"project": "string",
"reserved_by": "string",
"ttl": 0,
"serial_number": 0,
"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
],
"bindings": [{"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"resource_type": "string"
}
]
}
}

Delete zone

Delete a private zone.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Responses

Response samples

401
403
404

Content type

application/json

{"code": 0,
"message": "string"
}

Record sets

List record sets

Returns a list of record sets for a private zone.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Responses

Response samples

200
401
403
404

Content type

application/json

{"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
]
}

Hard update record sets

Overwrite (hard update) record sets of a private zone. All existing values in record sets will be replaced with the ones provided in the request.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Request Body schema: application/json

generated	boolean If true, mark record sets as generated by an integration so that future syncs may update them.
	Array of objects (recordSetAddBody) <= 1000 items List of record sets to add or replace.
	Array of objects (recordSetDeleteBody) <= 1000 items List of record sets to delete.

Responses

Request samples

Payload

Content type

application/json

{"generated": true,
"set": [{"type": "A",
"domain": "sub.domain.com.",
"ttl": -1,
"values": ["string"
]
}
],
"delete": [{"type": "A",
"domain": "sub.domain.com."
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

{"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
]
}

Soft update record sets

Add to or remove particular values (soft update) from record sets of a private zone. Values provided in the request will be deleted or added to the existing ones.

Authorizations:

iam_token_project_scoped

path Parameters

zone_id

required

string <uuid>

Example: cf2dfff0-cd93-43ee-a7ea-810dabab9676

Zone identifier.

Request Body schema: application/json

generated	boolean If true, mark record sets as generated by an integration so that future syncs may update them.
	Array of objects List of record sets to add or remove.

Responses

Request samples

Payload

Content type

application/json

{"generated": true,
"records": [{"type": "A",
"domain": "sub.domain.com.",
"ttl": -1,
"add": ["string"
],
"delete": ["string"
]
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

{"records": [{"type": "A",
"domain": "sub.domain.com.",
"generated": true,
"ttl": -1,
"values": ["string"
]
}
]
}