Record sets
All operations require authentication.
List GSLB record sets in a hosted zoneAlpha
Path parameters
Zone ID
Query parameters
Filter by exact record set name, ignoring case. The trailing dot is optional.
Filter by DNS record type
AAAAACNAMEMXTXTHeaders
Pagination cursor
Pagination size
Response
Target record name for chained routing. Null when the record set is not chained.
Endpoint coordinates for GEOPROXIMITY
Creation timestamp
Whether to fall through to the global scope when a GEOLOCATION chain target is unhealthy, always false for other record sets
Failover role of this entry, null for routing policies other than FAILOVER
PRIMARYSECONDARYGeographic routing scope, required for GEOLOCATION routing. Null when not set.
Identifier of the associated health check. Null when no health check is linked.
Unique identifier of the record set
Fully qualified domain name with a trailing dot
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTraffic routing policy
FAILOVERGEOLOCATIONGEOPROXIMITYMULTIVALUESIMPLEWEIGHTEDIdentifier distinguishing entries with the same name and type, can be null only for SIMPLE routing
Time to live in seconds. Record sets with the same name and type share one TTL. Updating the TTL updates all of them.
DNS record type
AAAAACNAMEMXTXTLast modification timestamp
DNS record values. Empty when chainTarget is set.
Weight from 0 to 255, required for WEIGHTED routing. Null when not set.
Identifier of the parent hosted zone
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ recordSet \
-H "authorization: Bearer $OVH_TOKEN"[ { "chainTarget": "string", "coordinates": { "latitude": 0, "longitude": 0 }, "createdAt": "2024-01-01T12:00:00Z", "evaluateTargetHealth": true, "failover": "PRIMARY", "geoLocation": { "continentCode": "AF", "countryCode": "AC", "subdivisionCode": "string" }, "healthCheckId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "resourceStatus": "CREATING", "routingPolicy": "FAILOVER", "setIdentifier": "string", "ttl": 0, "type": "A", "updatedAt": "2024-01-01T12:00:00Z", "values": [ "string" ], "weight": 0, "zoneId": "00000000-0000-0000-0000-000000000000" }]
Get a GSLB record setAlpha
Path parameters
Record set ID
Zone ID
Response
Target record name for chained routing. Null when the record set is not chained.
Endpoint coordinates for GEOPROXIMITY
Creation timestamp
Whether to fall through to the global scope when a GEOLOCATION chain target is unhealthy, always false for other record sets
Failover role of this entry, null for routing policies other than FAILOVER
PRIMARYSECONDARYGeographic routing scope, required for GEOLOCATION routing. Null when not set.
Identifier of the associated health check. Null when no health check is linked.
Unique identifier of the record set
Fully qualified domain name with a trailing dot
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTraffic routing policy
FAILOVERGEOLOCATIONGEOPROXIMITYMULTIVALUESIMPLEWEIGHTEDIdentifier distinguishing entries with the same name and type, can be null only for SIMPLE routing
Time to live in seconds. Record sets with the same name and type share one TTL. Updating the TTL updates all of them.
DNS record type
AAAAACNAMEMXTXTLast modification timestamp
DNS record values. Empty when chainTarget is set.
Weight from 0 to 255, required for WEIGHTED routing. Null when not set.
Identifier of the parent hosted zone
Example uses recordSetId = 00000000-0000-0000-0000-000000000000, zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ recordSet/ {recordSetId} \
-H "authorization: Bearer $OVH_TOKEN"{ "chainTarget": "string", "coordinates": { "latitude": 0, "longitude": 0 }, "createdAt": "2024-01-01T12:00:00Z", "evaluateTargetHealth": true, "failover": "PRIMARY", "geoLocation": { "continentCode": "AF", "countryCode": "AC", "subdivisionCode": "string" }, "healthCheckId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "resourceStatus": "CREATING", "routingPolicy": "FAILOVER", "setIdentifier": "string", "ttl": 0, "type": "A", "updatedAt": "2024-01-01T12:00:00Z", "values": [ "string" ], "weight": 0, "zoneId": "00000000-0000-0000-0000-000000000000"}
Create a GSLB record setAlpha
Path parameters
Zone ID
Request body (required)
Target record name for chaining, up to three hops. Unavailable for GEOPROXIMITY parents.
Endpoint coordinates, required for GEOPROXIMITY routing
Whether to fall through to the global scope when the chain target is unhealthy. Only supported for GEOLOCATION chains.
Failover role of this entry, required for FAILOVER routing. PRIMARY requires a health check. Immutable after creation.
PRIMARYSECONDARYGeographic scope of this entry, required for GEOLOCATION routing. An empty object is the global fallback.
Associated health check. Unsupported for SIMPLE.
Fully qualified domain name in the hosted zone, ending with a dot. Immutable after creation.
Traffic routing policy, defaults to SIMPLE. Immutable after creation.
FAILOVERGEOLOCATIONGEOPROXIMITYMULTIVALUESIMPLEWEIGHTEDIdentifier that distinguishes entries with the same name and type. Required for non-SIMPLE routing. At most 128 characters.
Time to live in seconds. Record sets with the same name and type share one TTL. The value must equal the TTL of any existing one. From 0 to 2147483647.
DNS record type. FAILOVER, GEOLOCATION, MULTIVALUE and GEOPROXIMITY require A or AAAA. Immutable after creation.
AAAAACNAMEMXTXTRecord values. Required unless chainTarget is set. A CNAME accepts a single value. MULTIVALUE and GEOPROXIMITY accept one value per entry.
Relative weight of this entry for WEIGHTED routing. Required for WEIGHTED routing. From 0 to 255.
Response
Target record name for chained routing. Null when the record set is not chained.
Endpoint coordinates for GEOPROXIMITY
Creation timestamp
Whether to fall through to the global scope when a GEOLOCATION chain target is unhealthy, always false for other record sets
Failover role of this entry, null for routing policies other than FAILOVER
PRIMARYSECONDARYGeographic routing scope, required for GEOLOCATION routing. Null when not set.
Identifier of the associated health check. Null when no health check is linked.
Unique identifier of the record set
Fully qualified domain name with a trailing dot
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTraffic routing policy
FAILOVERGEOLOCATIONGEOPROXIMITYMULTIVALUESIMPLEWEIGHTEDIdentifier distinguishing entries with the same name and type, can be null only for SIMPLE routing
Time to live in seconds. Record sets with the same name and type share one TTL. Updating the TTL updates all of them.
DNS record type
AAAAACNAMEMXTXTLast modification timestamp
DNS record values. Empty when chainTarget is set.
Weight from 0 to 255, required for WEIGHTED routing. Null when not set.
Identifier of the parent hosted zone
Example uses zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ recordSet \
-H "authorization: Bearer $OVH_TOKEN"{ "chainTarget": "string", "coordinates": { "latitude": 0, "longitude": 0 }, "createdAt": "2024-01-01T12:00:00Z", "evaluateTargetHealth": true, "failover": "PRIMARY", "geoLocation": { "continentCode": "AF", "countryCode": "AC", "subdivisionCode": "string" }, "healthCheckId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "resourceStatus": "CREATING", "routingPolicy": "FAILOVER", "setIdentifier": "string", "ttl": 0, "type": "A", "updatedAt": "2024-01-01T12:00:00Z", "values": [ "string" ], "weight": 0, "zoneId": "00000000-0000-0000-0000-000000000000"}
Update a GSLB record set. Name, type, routing policy and failover role are immutable.Alpha
Omitted fields keep their current value. A null value removes a field, except ttl and values, which cannot be null.
Record sets with the same name and type share one TTL. Updating the TTL updates all of them.
Linking a health check also requires the gslbHealthCheck:apiovh:get action on that health check.
Path parameters
Record set ID
Zone ID
Request body (required)
New target record name for chained routing. When null or empty, the chain target is removed.
New endpoint coordinates for GEOPROXIMITY routing. When null, the coordinates are removed.
Whether to fall through to the global scope when a GEOLOCATION chain target is unhealthy. When null, the value is reset to false.
New geographic scope for GEOLOCATION routing. When null, the scope is removed.
Health check to link. Omit it to keep the current link, or set it to null to unlink the current health check.
New identifier distinguishing entries with the same name and type. When null, the identifier is removed, which is only valid for SIMPLE routing.
New time to live in seconds. Record sets with the same name and type share one TTL. Updating the TTL updates all of them. When omitted, the current TTL is kept. A null value is rejected. From 0 to 2147483647.
New record values. The list replaces the one currently set. When omitted, the current values are kept. A null value is rejected.
New relative weight for WEIGHTED routing. When null, the weight is removed. From 0 to 255.
Response
Target record name for chained routing. Null when the record set is not chained.
Endpoint coordinates for GEOPROXIMITY
Creation timestamp
Whether to fall through to the global scope when a GEOLOCATION chain target is unhealthy, always false for other record sets
Failover role of this entry, null for routing policies other than FAILOVER
PRIMARYSECONDARYGeographic routing scope, required for GEOLOCATION routing. Null when not set.
Identifier of the associated health check. Null when no health check is linked.
Unique identifier of the record set
Fully qualified domain name with a trailing dot
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTraffic routing policy
FAILOVERGEOLOCATIONGEOPROXIMITYMULTIVALUESIMPLEWEIGHTEDIdentifier distinguishing entries with the same name and type, can be null only for SIMPLE routing
Time to live in seconds. Record sets with the same name and type share one TTL. Updating the TTL updates all of them.
DNS record type
AAAAACNAMEMXTXTLast modification timestamp
DNS record values. Empty when chainTarget is set.
Weight from 0 to 255, required for WEIGHTED routing. Null when not set.
Identifier of the parent hosted zone
Example uses recordSetId = 00000000-0000-0000-0000-000000000000, zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ recordSet/ {recordSetId} \
-H "authorization: Bearer $OVH_TOKEN"{ "chainTarget": "string", "coordinates": { "latitude": 0, "longitude": 0 }, "createdAt": "2024-01-01T12:00:00Z", "evaluateTargetHealth": true, "failover": "PRIMARY", "geoLocation": { "continentCode": "AF", "countryCode": "AC", "subdivisionCode": "string" }, "healthCheckId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "resourceStatus": "CREATING", "routingPolicy": "FAILOVER", "setIdentifier": "string", "ttl": 0, "type": "A", "updatedAt": "2024-01-01T12:00:00Z", "values": [ "string" ], "weight": 0, "zoneId": "00000000-0000-0000-0000-000000000000"}
Delete a GSLB record setAlpha
Path parameters
Record set ID
Zone ID
Response
Example uses recordSetId = 00000000-0000-0000-0000-000000000000, zoneId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ zone/ {zoneId}/ recordSet/ {recordSetId} \
-H "authorization: Bearer $OVH_TOKEN"