Health checks
All operations require authentication.
List GSLB health checksAlpha
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Creation timestamp
Whether check execution is disabled
Name queried by DNS health checks, required for the DNS type. Null when not set.
Record type queried by DNS health checks, required for the DNS type. Null when not set.
AAAAACNAMEMXTXTConsecutive failures before marking the endpoint unhealthy
FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.
Current endpoint health
HEALTHYUNHEALTHYUNKNOWNIAM resource metadata
Unique identifier of the health check
Whether health status is inverted
Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.
Last execution timestamp. Null until the first check has run.
Error of the most recent check. Null when that check succeeded or no check has run yet.
Optional health check name
Endpoint port, null for protocols that do not use one, such as ICMP
Interval between checks, 10 or 30 seconds
HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGString expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Health check protocol
DNSHTTPHTTPSHTTPS_STR_MATCHHTTP_STR_MATCHICMPTCPLast modification timestamp
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "disabled": true, "dnsQueryName": "string", "dnsRecordType": "A", "failureThreshold": 0, "fqdn": "string", "healthStatus": "HEALTHY", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "inverted": true, "ipAddress": "192.0.2.0", "lastCheckedAt": "2024-01-01T12:00:00Z", "lastError": "string", "name": "string", "port": 0, "requestInterval": 0, "resourcePath": "string", "resourceStatus": "CREATING", "searchString": "string", "type": "DNS", "updatedAt": "2024-01-01T12:00:00Z" }]
Get a GSLB health checkAlpha
Path parameters
Health check ID
Response
Creation timestamp
Whether check execution is disabled
Name queried by DNS health checks, required for the DNS type. Null when not set.
Record type queried by DNS health checks, required for the DNS type. Null when not set.
AAAAACNAMEMXTXTConsecutive failures before marking the endpoint unhealthy
FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.
Current endpoint health
HEALTHYUNHEALTHYUNKNOWNIAM resource metadata
Unique identifier of the health check
Whether health status is inverted
Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.
Last execution timestamp. Null until the first check has run.
Error of the most recent check. Null when that check succeeded or no check has run yet.
Optional health check name
Endpoint port, null for protocols that do not use one, such as ICMP
Interval between checks, 10 or 30 seconds
HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGString expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Health check protocol
DNSHTTPHTTPSHTTPS_STR_MATCHHTTP_STR_MATCHICMPTCPLast modification timestamp
Example uses healthCheckId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck/ {healthCheckId} \
-H "authorization: Bearer $OVH_TOKEN"{ "createdAt": "2024-01-01T12:00:00Z", "disabled": true, "dnsQueryName": "string", "dnsRecordType": "A", "failureThreshold": 0, "fqdn": "string", "healthStatus": "HEALTHY", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "inverted": true, "ipAddress": "192.0.2.0", "lastCheckedAt": "2024-01-01T12:00:00Z", "lastError": "string", "name": "string", "port": 0, "requestInterval": 0, "resourcePath": "string", "resourceStatus": "CREATING", "searchString": "string", "type": "DNS", "updatedAt": "2024-01-01T12:00:00Z"}
Create a GSLB health checkAlpha
Request body (required)
Disable execution. Defaults to false.
Name queried by DNS health checks
Record type queried by DNS health checks
AAAAACNAMEMXTXTConsecutive failures from 1 to 10. Defaults to 3.
FQDN for the HTTP Host header and TLS SNI
Invert health status. Defaults to false.
Public IPv4 or IPv6 endpoint address. Private and loopback addresses are rejected. Required for ICMP, and for other protocols unless fqdn is set.
Optional name. At most 255 characters.
Endpoint port from 1 to 65535 when required by the protocol
Interval of 10 or 30 seconds. Defaults to 30.
HTTP request path starting with /. At most 255 characters.
Expected response text for HTTP_STR_MATCH or HTTPS_STR_MATCH
Health check protocol. Immutable after creation.
DNSHTTPHTTPSHTTPS_STR_MATCHHTTP_STR_MATCHICMPTCPResponse
Creation timestamp
Whether check execution is disabled
Name queried by DNS health checks, required for the DNS type. Null when not set.
Record type queried by DNS health checks, required for the DNS type. Null when not set.
AAAAACNAMEMXTXTConsecutive failures before marking the endpoint unhealthy
FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.
Current endpoint health
HEALTHYUNHEALTHYUNKNOWNUnique identifier of the health check
Whether health status is inverted
Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.
Last execution timestamp. Null until the first check has run.
Error of the most recent check. Null when that check succeeded or no check has run yet.
Optional health check name
Endpoint port, null for protocols that do not use one, such as ICMP
Interval between checks, 10 or 30 seconds
HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGString expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Health check protocol
DNSHTTPHTTPSHTTPS_STR_MATCHHTTP_STR_MATCHICMPTCPLast modification timestamp
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck \
-H "authorization: Bearer $OVH_TOKEN"{ "createdAt": "2024-01-01T12:00:00Z", "disabled": true, "dnsQueryName": "string", "dnsRecordType": "A", "failureThreshold": 0, "fqdn": "string", "healthStatus": "HEALTHY", "id": "00000000-0000-0000-0000-000000000000", "inverted": true, "ipAddress": "192.0.2.0", "lastCheckedAt": "2024-01-01T12:00:00Z", "lastError": "string", "name": "string", "port": 0, "requestInterval": 0, "resourcePath": "string", "resourceStatus": "CREATING", "searchString": "string", "type": "DNS", "updatedAt": "2024-01-01T12:00:00Z"}
Update a GSLB health check. Its protocol type is immutable.Alpha
Path parameters
Health check ID
Request body (required)
Whether to disable check execution. When null, checks are enabled.
New name queried by DNS health checks. When null, the name is removed.
New record type queried by DNS health checks. When null, the record type is removed.
AAAAACNAMEMXTXTNew number of consecutive failures. When null, the default of 3 is restored. From 1 to 10.
New FQDN for the HTTP Host header and TLS SNI. When null, the FQDN is removed.
Whether to invert the health status. When null, the health status is not inverted.
New public IPv4 or IPv6 endpoint address. When null, the address is removed.
New health check name. When null, the name is removed.
New endpoint port. When null, the port is removed, which is only valid for protocols that do not use a port, such as ICMP. From 1 to 65535.
New interval of 10 or 30 seconds. When null, the default of 30 is restored.
New HTTP request path starting with /. When null, the path is removed.
New expected HTTP response text. When null, the text is removed.
Response
Creation timestamp
Whether check execution is disabled
Name queried by DNS health checks, required for the DNS type. Null when not set.
Record type queried by DNS health checks, required for the DNS type. Null when not set.
AAAAACNAMEMXTXTConsecutive failures before marking the endpoint unhealthy
FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.
Current endpoint health
HEALTHYUNHEALTHYUNKNOWNUnique identifier of the health check
Whether health status is inverted
Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.
Last execution timestamp. Null until the first check has run.
Error of the most recent check. Null when that check succeeded or no check has run yet.
Optional health check name
Endpoint port, null for protocols that do not use one, such as ICMP
Interval between checks, 10 or 30 seconds
HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Resource lifecycle status
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGString expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.
Health check protocol
DNSHTTPHTTPSHTTPS_STR_MATCHHTTP_STR_MATCHICMPTCPLast modification timestamp
Example uses healthCheckId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck/ {healthCheckId} \
-H "authorization: Bearer $OVH_TOKEN"{ "createdAt": "2024-01-01T12:00:00Z", "disabled": true, "dnsQueryName": "string", "dnsRecordType": "A", "failureThreshold": 0, "fqdn": "string", "healthStatus": "HEALTHY", "id": "00000000-0000-0000-0000-000000000000", "inverted": true, "ipAddress": "192.0.2.0", "lastCheckedAt": "2024-01-01T12:00:00Z", "lastError": "string", "name": "string", "port": 0, "requestInterval": 0, "resourcePath": "string", "resourceStatus": "CREATING", "searchString": "string", "type": "DNS", "updatedAt": "2024-01-01T12:00:00Z"}
Delete a health check not referenced by any record setAlpha
Path parameters
Health check ID
Response
Example uses healthCheckId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck/ {healthCheckId} \
-H "authorization: Bearer $OVH_TOKEN"Get the current status of a GSLB health checkAlpha
Path parameters
Health check ID
Response
Identifier of the health check
Last execution timestamp. Null until the first check has run.
Current endpoint health
HEALTHYUNHEALTHYUNKNOWNExample uses healthCheckId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ dns/ gslb/ healthCheck/ {healthCheckId}/ status \
-H "authorization: Bearer $OVH_TOKEN"{ "healthCheckId": "00000000-0000-0000-0000-000000000000", "lastCheckedAt": "2024-01-01T12:00:00Z", "status": "HEALTHY"}