{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"dns.gslb.CreateHealthCheckRequest":{"type":"object","description":"Create a GSLB health check. Target and protocol-specific fields are validated by the backend.","properties":{"disabled":{"type":"boolean","description":"Disable execution. Defaults to false.","nullable":true},"dnsQueryName":{"type":"string","description":"Name queried by DNS health checks","nullable":true},"dnsRecordType":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckRecordTypeEnum"}],"description":"Record type queried by DNS health checks","nullable":true},"failureThreshold":{"type":"integer","description":"Consecutive failures from 1 to 10. Defaults to 3.","nullable":true},"fqdn":{"type":"string","description":"FQDN for the HTTP Host header and TLS SNI","nullable":true},"inverted":{"type":"boolean","description":"Invert health status. Defaults to false.","nullable":true},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Public IPv4 or IPv6 endpoint address. Private and loopback addresses are rejected. Required for ICMP, and for other protocols unless fqdn is set.","nullable":true},"name":{"type":"string","description":"Optional name. At most 255 characters.","nullable":true},"port":{"type":"integer","description":"Endpoint port from 1 to 65535 when required by the protocol","nullable":true},"requestInterval":{"type":"integer","description":"Interval of 10 or 30 seconds. Defaults to 30.","nullable":true},"resourcePath":{"type":"string","description":"HTTP request path starting with /. At most 255 characters.","nullable":true},"searchString":{"type":"string","description":"Expected response text for HTTP_STR_MATCH or HTTPS_STR_MATCH","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckTypeEnum"}],"description":"Health check protocol. Immutable after creation."}},"required":["type"]},"dns.gslb.HealthCheck":{"type":"object","description":"GSLB health check configuration and observed status","properties":{"createdAt":{"type":"string","description":"Creation timestamp","format":"date-time","readOnly":true},"disabled":{"type":"boolean","description":"Whether check execution is disabled","readOnly":true},"dnsQueryName":{"type":"string","description":"Name queried by DNS health checks, required for the DNS type. Null when not set.","nullable":true,"readOnly":true},"dnsRecordType":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckRecordTypeEnum"}],"description":"Record type queried by DNS health checks, required for the DNS type. Null when not set.","nullable":true,"readOnly":true},"failureThreshold":{"type":"integer","description":"Consecutive failures before marking the endpoint unhealthy","readOnly":true},"fqdn":{"type":"string","description":"FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.","nullable":true,"readOnly":true},"healthStatus":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthStatusEnum"}],"description":"Current endpoint health","readOnly":true},"id":{"type":"string","description":"Unique identifier of the health check","format":"uuid","readOnly":true},"inverted":{"type":"boolean","description":"Whether health status is inverted","readOnly":true},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.","nullable":true,"readOnly":true},"lastCheckedAt":{"type":"string","description":"Last execution timestamp. Null until the first check has run.","nullable":true,"format":"date-time","readOnly":true},"lastError":{"type":"string","description":"Error of the most recent check. Null when that check succeeded or no check has run yet.","nullable":true,"readOnly":true},"name":{"type":"string","description":"Optional health check name","nullable":true,"readOnly":true},"port":{"type":"integer","description":"Endpoint port, null for protocols that do not use one, such as ICMP","nullable":true,"readOnly":true},"requestInterval":{"type":"integer","description":"Interval between checks, 10 or 30 seconds","readOnly":true},"resourcePath":{"type":"string","description":"HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.","nullable":true,"readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Resource lifecycle status","readOnly":true},"searchString":{"type":"string","description":"String expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckTypeEnum"}],"description":"Health check protocol","readOnly":true},"updatedAt":{"type":"string","description":"Last modification timestamp","format":"date-time","readOnly":true}}},"dns.gslb.HealthCheckRecordTypeEnum":{"type":"string","description":"DNS record types supported by DNS health checks","enum":["A","AAAA","CNAME","MX","TXT"]},"dns.gslb.HealthCheckStatus":{"type":"object","description":"Observed status of a GSLB health check","properties":{"healthCheckId":{"type":"string","description":"Identifier of the health check","format":"uuid","readOnly":true},"lastCheckedAt":{"type":"string","description":"Last execution timestamp. Null until the first check has run.","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthStatusEnum"}],"description":"Current endpoint health","readOnly":true}}},"dns.gslb.HealthCheckTypeEnum":{"type":"string","description":"Supported GSLB health check protocols","enum":["DNS","HTTP","HTTPS","HTTPS_STR_MATCH","HTTP_STR_MATCH","ICMP","TCP"]},"dns.gslb.HealthCheckWithIAM":{"type":"object","description":"GSLB health check configuration and observed status","properties":{"createdAt":{"type":"string","description":"Creation timestamp","format":"date-time","readOnly":true},"disabled":{"type":"boolean","description":"Whether check execution is disabled","readOnly":true},"dnsQueryName":{"type":"string","description":"Name queried by DNS health checks, required for the DNS type. Null when not set.","nullable":true,"readOnly":true},"dnsRecordType":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckRecordTypeEnum"}],"description":"Record type queried by DNS health checks, required for the DNS type. Null when not set.","nullable":true,"readOnly":true},"failureThreshold":{"type":"integer","description":"Consecutive failures before marking the endpoint unhealthy","readOnly":true},"fqdn":{"type":"string","description":"FQDN used for the HTTP Host header and TLS SNI. Null when the check targets only ipAddress.","nullable":true,"readOnly":true},"healthStatus":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthStatusEnum"}],"description":"Current endpoint health","readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the health check","format":"uuid","readOnly":true},"inverted":{"type":"boolean","description":"Whether health status is inverted","readOnly":true},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Public IPv4 or IPv6 endpoint address. Null when the check targets only fqdn.","nullable":true,"readOnly":true},"lastCheckedAt":{"type":"string","description":"Last execution timestamp. Null until the first check has run.","nullable":true,"format":"date-time","readOnly":true},"lastError":{"type":"string","description":"Error of the most recent check. Null when that check succeeded or no check has run yet.","nullable":true,"readOnly":true},"name":{"type":"string","description":"Optional health check name","nullable":true,"readOnly":true},"port":{"type":"integer","description":"Endpoint port, null for protocols that do not use one, such as ICMP","nullable":true,"readOnly":true},"requestInterval":{"type":"integer","description":"Interval between checks, 10 or 30 seconds","readOnly":true},"resourcePath":{"type":"string","description":"HTTP request path, required for the HTTP, HTTPS, HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.","nullable":true,"readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Resource lifecycle status","readOnly":true},"searchString":{"type":"string","description":"String expected in the HTTP response body, required for the HTTP_STR_MATCH and HTTPS_STR_MATCH types. Null when not set.","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckTypeEnum"}],"description":"Health check protocol","readOnly":true},"updatedAt":{"type":"string","description":"Last modification timestamp","format":"date-time","readOnly":true}}},"dns.gslb.HealthStatusEnum":{"type":"string","description":"Observed endpoint health","enum":["HEALTHY","UNHEALTHY","UNKNOWN"]},"dns.gslb.UpdateHealthCheckRequest":{"type":"object","description":"Partial update of a GSLB health check. Omitted fields keep their current value. A null value removes a field or restores its default. The result is validated as on creation. The protocol type cannot be changed.","properties":{"disabled":{"type":"boolean","description":"Whether to disable check execution. When null, checks are enabled.","nullable":true},"dnsQueryName":{"type":"string","description":"New name queried by DNS health checks. When null, the name is removed.","nullable":true},"dnsRecordType":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.HealthCheckRecordTypeEnum"}],"description":"New record type queried by DNS health checks. When null, the record type is removed.","nullable":true},"failureThreshold":{"type":"integer","description":"New number of consecutive failures. When null, the default of 3 is restored. From 1 to 10.","nullable":true},"fqdn":{"type":"string","description":"New FQDN for the HTTP Host header and TLS SNI. When null, the FQDN is removed.","nullable":true},"inverted":{"type":"boolean","description":"Whether to invert the health status. When null, the health status is not inverted.","nullable":true},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"New public IPv4 or IPv6 endpoint address. When null, the address is removed.","nullable":true},"name":{"type":"string","description":"New health check name. When null, the name is removed.","nullable":true},"port":{"type":"integer","description":"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.","nullable":true},"requestInterval":{"type":"integer","description":"New interval of 10 or 30 seconds. When null, the default of 30 is restored.","nullable":true},"resourcePath":{"type":"string","description":"New HTTP request path starting with /. When null, the path is removed.","nullable":true},"searchString":{"type":"string","description":"New expected HTTP response text. When null, the text is removed.","nullable":true}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value. Defaults to `EQ`.","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/dns/gslb/healthCheck":{"get":{"operationId":"getAllGslbHealthChecks","summary":"List GSLB health checks","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dns.gslb.HealthCheckWithIAM"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::ValidationError":{"value":{"class":"Client::BadRequest::ValidationError","message":"Your request contains an invalid parameter or configuration: {{.reason}}"}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@10"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/dns/gslb/healthCheck\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/dns/gslb/healthCheck\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:get","required":true}],"x-expanded-response":"DnsGslbHealthCheckWithIAM"},"post":{"operationId":"createGslbHealthCheck","summary":"Create a GSLB health check","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.CreateHealthCheckRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HealthCheck"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::ValidationError":{"value":{"class":"Client::BadRequest::ValidationError","message":"Your request contains an invalid parameter or configuration: {{.reason}}"}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@30"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: dns.gslb.CreateHealthCheckRequest\nresult = client.post(\"/v2/dns/gslb/healthCheck\",\n\tdisabled = None, # Disable execution. Defaults to false. (type: boolean, nullable)\n\tdnsQueryName = None, # Name queried by DNS health checks (type: string, nullable)\n\tdnsRecordType = None, # Record type queried by DNS health checks (type: dns.gslb.HealthCheckRecordTypeEnum, nullable)\n\tfailureThreshold = None, # Consecutive failures from 1 to 10. Defaults to 3. (type: integer, nullable)\n\tfqdn = None, # FQDN for the HTTP Host header and TLS SNI (type: string, nullable)\n\tinverted = None, # Invert health status. Defaults to false. (type: boolean, nullable)\n\tipAddress = None, # Public IPv4 or IPv6 endpoint address. Private and loopback addresses are rejected. Required for ICMP, and for other protocols unless fqdn is set. (type: ip, nullable)\n\tname = None, # Optional name. At most 255 characters. (type: string, nullable)\n\tport = None, # Endpoint port from 1 to 65535 when required by the protocol (type: integer, nullable)\n\trequestInterval = None, # Interval of 10 or 30 seconds. Defaults to 30. (type: integer, nullable)\n\tresourcePath = None, # HTTP request path starting with /. At most 255 characters. (type: string, nullable)\n\tsearchString = None, # Expected response text for HTTP_STR_MATCH or HTTPS_STR_MATCH (type: string, nullable)\n\ttype = None, # Health check protocol. Immutable after creation. (type: dns.gslb.HealthCheckTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: dns.gslb.CreateHealthCheckRequest\n$result = $ovh->post(\"/v2/dns/gslb/healthCheck\", array(\n\tdisabled => null, // Disable execution. Defaults to false. (type: boolean, nullable)\n\tdnsQueryName => null, // Name queried by DNS health checks (type: string, nullable)\n\tdnsRecordType => null, // Record type queried by DNS health checks (type: dns.gslb.HealthCheckRecordTypeEnum, nullable)\n\tfailureThreshold => null, // Consecutive failures from 1 to 10. Defaults to 3. (type: integer, nullable)\n\tfqdn => null, // FQDN for the HTTP Host header and TLS SNI (type: string, nullable)\n\tinverted => null, // Invert health status. Defaults to false. (type: boolean, nullable)\n\tipAddress => null, // Public IPv4 or IPv6 endpoint address. Private and loopback addresses are rejected. Required for ICMP, and for other protocols unless fqdn is set. (type: ip, nullable)\n\tname => null, // Optional name. At most 255 characters. (type: string, nullable)\n\tport => null, // Endpoint port from 1 to 65535 when required by the protocol (type: integer, nullable)\n\trequestInterval => null, // Interval of 10 or 30 seconds. Defaults to 30. (type: integer, nullable)\n\tresourcePath => null, // HTTP request path starting with /. At most 255 characters. (type: string, nullable)\n\tsearchString => null, // Expected response text for HTTP_STR_MATCH or HTTPS_STR_MATCH (type: string, nullable)\n\ttype => null, // Health check protocol. Immutable after creation. (type: dns.gslb.HealthCheckTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:create","required":true}]}},"/dns/gslb/healthCheck/{healthCheckId}":{"delete":{"operationId":"deleteGslbHealthCheck","summary":"Delete a health check not referenced by any record set","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"healthCheckId","description":"Health check ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@50"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/dns/gslb/healthCheck/{healthCheckId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/dns/gslb/healthCheck/{healthCheckId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:delete","required":true}]},"get":{"operationId":"getGslbHealthCheck","summary":"Get a GSLB health check","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"healthCheckId","description":"Health check ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HealthCheckWithIAM"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::HealthCheckNotFound":{"value":{"class":"Client::NotFound::HealthCheckNotFound","message":"Your health check was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@20"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/dns/gslb/healthCheck/{healthCheckId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/dns/gslb/healthCheck/{healthCheckId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:get","required":true}]},"patch":{"operationId":"updateGslbHealthCheck","summary":"Update a GSLB health check. Its protocol type is immutable.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"healthCheckId","description":"Health check ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.UpdateHealthCheckRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HealthCheck"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::ValidationError":{"value":{"class":"Client::BadRequest::ValidationError","message":"Your request contains an invalid parameter or configuration: {{.reason}}"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::HealthCheckNotFound":{"value":{"class":"Client::NotFound::HealthCheckNotFound","message":"Your health check was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@40"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: dns.gslb.UpdateHealthCheckRequest\nresult = client.patch(\"/v2/dns/gslb/healthCheck/{healthCheckId}\",\n\tdisabled = None, # Whether to disable check execution. When null, checks are enabled. (type: boolean, nullable)\n\tdnsQueryName = None, # New name queried by DNS health checks. When null, the name is removed. (type: string, nullable)\n\tdnsRecordType = None, # New record type queried by DNS health checks. When null, the record type is removed. (type: dns.gslb.HealthCheckRecordTypeEnum, nullable)\n\tfailureThreshold = None, # New number of consecutive failures. When null, the default of 3 is restored. From 1 to 10. (type: integer, nullable)\n\tfqdn = None, # New FQDN for the HTTP Host header and TLS SNI. When null, the FQDN is removed. (type: string, nullable)\n\tinverted = None, # Whether to invert the health status. When null, the health status is not inverted. (type: boolean, nullable)\n\tipAddress = None, # New public IPv4 or IPv6 endpoint address. When null, the address is removed. (type: ip, nullable)\n\tname = None, # New health check name. When null, the name is removed. (type: string, nullable)\n\tport = None, # 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. (type: integer, nullable)\n\trequestInterval = None, # New interval of 10 or 30 seconds. When null, the default of 30 is restored. (type: integer, nullable)\n\tresourcePath = None, # New HTTP request path starting with /. When null, the path is removed. (type: string, nullable)\n\tsearchString = None, # New expected HTTP response text. When null, the text is removed. (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: dns.gslb.UpdateHealthCheckRequest\n$result = $ovh->patch(\"/v2/dns/gslb/healthCheck/{healthCheckId}\", array(\n\tdisabled => null, // Whether to disable check execution. When null, checks are enabled. (type: boolean, nullable)\n\tdnsQueryName => null, // New name queried by DNS health checks. When null, the name is removed. (type: string, nullable)\n\tdnsRecordType => null, // New record type queried by DNS health checks. When null, the record type is removed. (type: dns.gslb.HealthCheckRecordTypeEnum, nullable)\n\tfailureThreshold => null, // New number of consecutive failures. When null, the default of 3 is restored. From 1 to 10. (type: integer, nullable)\n\tfqdn => null, // New FQDN for the HTTP Host header and TLS SNI. When null, the FQDN is removed. (type: string, nullable)\n\tinverted => null, // Whether to invert the health status. When null, the health status is not inverted. (type: boolean, nullable)\n\tipAddress => null, // New public IPv4 or IPv6 endpoint address. When null, the address is removed. (type: ip, nullable)\n\tname => null, // New health check name. When null, the name is removed. (type: string, nullable)\n\tport => null, // 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. (type: integer, nullable)\n\trequestInterval => null, // New interval of 10 or 30 seconds. When null, the default of 30 is restored. (type: integer, nullable)\n\tresourcePath => null, // New HTTP request path starting with /. When null, the path is removed. (type: string, nullable)\n\tsearchString => null, // New expected HTTP response text. When null, the text is removed. (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:edit","required":true}]}},"/dns/gslb/healthCheck/{healthCheckId}/status":{"get":{"operationId":"getGslbHealthCheckStatus","summary":"Get the current status of a GSLB health check","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"healthCheckId","description":"Health check ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HealthCheckStatus"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::HealthCheckNotFound":{"value":{"class":"Client::NotFound::HealthCheckNotFound","message":"Your health check was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Health checks@@@60"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/dns/gslb/healthCheck/{healthCheckId}/status\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/dns/gslb/healthCheck/{healthCheckId}/status\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbHealthCheck:apiovh:get","required":true}]}}}}
