Zones
All operations require authentication.
List GSLB hosted zonesAlpha
Query parameters
Filter resources on IAM tags
Filter by zone name prefix, ignoring case. The filter applies to each page of authorized zones. A page can hold fewer zones than requested. The total counts every authorized zone.
Headers
Pagination cursor
Pagination size
Response
Optional zone description
Creation timestamp
IAM resource metadata
Unique identifier of the hosted zone
Fully qualified domain name with a trailing dot
Assigned authoritative nameservers
Number of record sets in the zone
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGStart of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.
Last modification timestamp
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone \
-H "authorization: Bearer $OVH_TOKEN"[ { "comment": "string", "createdAt": "2024-01-01T12:00:00Z", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "name": "string", "nameServers": [ "string" ], "recordCount": 0, "resourceStatus": "CREATING", "soa": { "expire": 0, "hostmaster": "string", "minimum": 0, "name": "string", "primary": "string", "refresh": 0, "retry": 0, "serial": 0, "ttl": 0 }, "updatedAt": "2024-01-01T12:00:00Z" }]
Get a GSLB hosted zoneAlpha
Path parameters
Zone ID
Response
Optional zone description
Creation timestamp
IAM resource metadata
Unique identifier of the hosted zone
Fully qualified domain name with a trailing dot
Assigned authoritative nameservers
Number of record sets in the zone
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGStart of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.
Last modification timestamp
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId} \
-H "authorization: Bearer $OVH_TOKEN"{ "comment": "string", "createdAt": "2024-01-01T12:00:00Z", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "name": "string", "nameServers": [ "string" ], "recordCount": 0, "resourceStatus": "CREATING", "soa": { "expire": 0, "hostmaster": "string", "minimum": 0, "name": "string", "primary": "string", "refresh": 0, "retry": 0, "serial": 0, "ttl": 0 }, "updatedAt": "2024-01-01T12:00:00Z"}
Create a GSLB hosted zone with SOA and NS recordsAlpha
Request body (required)
Optional description. At most 256 characters.
Fully qualified domain name with a trailing dot. Immutable after creation. At most 254 characters.
Response
Optional zone description
Creation timestamp
Unique identifier of the hosted zone
Fully qualified domain name with a trailing dot
Assigned authoritative nameservers
Number of record sets in the zone
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGStart of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.
Last modification timestamp
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone \
-H "authorization: Bearer $OVH_TOKEN"{ "comment": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "nameServers": [ "string" ], "recordCount": 0, "resourceStatus": "CREATING", "soa": { "expire": 0, "hostmaster": "string", "minimum": 0, "name": "string", "primary": "string", "refresh": 0, "retry": 0, "serial": 0, "ttl": 0 }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a GSLB hosted zone, including its SOA configurationAlpha
Path parameters
Zone ID
Request body (required)
New description. When omitted, the current comment is kept. When null, the comment is removed. At most 256 characters.
New authoritative name servers, each with a trailing dot. The list replaces the one currently set. When omitted, the current name servers are kept. When null, the default name servers are restored.
Partial update of the zone SOA configuration. When omitted, the current SOA is kept. A null value is rejected. The SOA cannot be removed.
Response
Optional zone description
Creation timestamp
Unique identifier of the hosted zone
Fully qualified domain name with a trailing dot
Assigned authoritative nameservers
Number of record sets in the zone
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGStart of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.
Last modification timestamp
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId} \
-H "authorization: Bearer $OVH_TOKEN"{ "comment": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "nameServers": [ "string" ], "recordCount": 0, "resourceStatus": "CREATING", "soa": { "expire": 0, "hostmaster": "string", "minimum": 0, "name": "string", "primary": "string", "refresh": 0, "retry": 0, "serial": 0, "ttl": 0 }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete an empty GSLB hosted zoneAlpha
Path parameters
Zone ID
Response
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId} \
-H "authorization: Bearer $OVH_TOKEN"Push the hosted zone and its record sets again to all GSLB name serversAlpha
Path parameters
Zone ID
Response
Explanation of a PARTIAL or ERROR status. It names the faulty record when the name servers reject the zone content. Null when status is OK.
Number of DNS resource record sets sent to the name servers, counting each name and type once and including SOA and NS
Aggregate push status: OK when every name server was updated, PARTIAL when the push failed on some but not all name servers, ERROR when it failed on every name server
ERROROKPARTIALHosted zone name
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ refresh \
-H "authorization: Bearer $OVH_TOKEN"{ "message": "string", "recordSetCount": 0, "status": "ERROR", "zone": "string"}