{"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.CreateHostedZoneRequest":{"type":"object","description":"Create a GSLB hosted zone","properties":{"comment":{"type":"string","description":"Optional description. At most 256 characters.","nullable":true},"name":{"type":"string","description":"Fully qualified domain name with a trailing dot. Immutable after creation. At most 254 characters."}},"required":["name"]},"dns.gslb.HostedZone":{"type":"object","description":"GSLB hosted zone and its SOA configuration","properties":{"comment":{"type":"string","description":"Optional zone description","nullable":true,"readOnly":true},"createdAt":{"type":"string","description":"Creation timestamp","format":"date-time","readOnly":true},"id":{"type":"string","description":"Unique identifier of the hosted zone","format":"uuid","readOnly":true},"name":{"type":"string","description":"Fully qualified domain name with a trailing dot","readOnly":true},"nameServers":{"type":"array","description":"Assigned authoritative nameservers","items":{"type":"string"},"readOnly":true},"recordCount":{"type":"integer","description":"Number of record sets in the zone","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Resource lifecycle status","readOnly":true},"soa":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.SoaRecord"}],"description":"Start of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.","nullable":true,"readOnly":true},"updatedAt":{"type":"string","description":"Last modification timestamp","format":"date-time","readOnly":true}}},"dns.gslb.HostedZoneWithIAM":{"type":"object","description":"GSLB hosted zone and its SOA configuration","properties":{"comment":{"type":"string","description":"Optional zone description","nullable":true,"readOnly":true},"createdAt":{"type":"string","description":"Creation timestamp","format":"date-time","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 hosted zone","format":"uuid","readOnly":true},"name":{"type":"string","description":"Fully qualified domain name with a trailing dot","readOnly":true},"nameServers":{"type":"array","description":"Assigned authoritative nameservers","items":{"type":"string"},"readOnly":true},"recordCount":{"type":"integer","description":"Number of record sets in the zone","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Resource lifecycle status","readOnly":true},"soa":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.SoaRecord"}],"description":"Start of Authority configuration for the hosted zone. Null when the name servers cannot currently report the SOA.","nullable":true,"readOnly":true},"updatedAt":{"type":"string","description":"Last modification timestamp","format":"date-time","readOnly":true}}},"dns.gslb.SoaRecord":{"type":"object","description":"SOA record of a GSLB hosted zone","properties":{"expire":{"type":"integer","description":"Expiry interval in seconds","readOnly":true},"hostmaster":{"type":"string","description":"Email address of the zone administrator, written in SOA RNAME format with the @ replaced by a dot, for example hostmaster.example.com.","readOnly":true},"minimum":{"type":"integer","description":"Negative caching time to live in seconds","readOnly":true},"name":{"type":"string","description":"Hosted zone name with a trailing dot","readOnly":true},"primary":{"type":"string","description":"Primary authoritative nameserver","readOnly":true},"refresh":{"type":"integer","description":"Refresh interval in seconds","readOnly":true},"retry":{"type":"integer","description":"Retry interval in seconds","readOnly":true},"serial":{"type":"integer","description":"SOA serial number","readOnly":true},"ttl":{"type":"integer","description":"Time to live of the SOA record in seconds","readOnly":true}}},"dns.gslb.SyncStatusEnum":{"type":"string","description":"Aggregate GSLB zone synchronization status","enum":["ERROR","OK","PARTIAL"]},"dns.gslb.UpdateHostedZoneRequest":{"type":"object","description":"Partial update of a GSLB hosted zone. Omitted fields keep their current value. Every field, the SOA included, is validated before any change is applied.","properties":{"comment":{"type":"string","description":"New description. When omitted, the current comment is kept. When null, the comment is removed. At most 256 characters.","nullable":true},"nameServers":{"type":"array","description":"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.","nullable":true,"items":{"type":"string"}},"soa":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.UpdateSoaRequest"}],"description":"Partial update of the zone SOA configuration. When omitted, the current SOA is kept. A null value is rejected. The SOA cannot be removed.","nullable":true}}},"dns.gslb.UpdateSoaRequest":{"type":"object","description":"Partial update of a GSLB SOA record. Omitted or null fields keep their current value. An SOA value cannot be removed.","properties":{"expire":{"type":"integer","description":"Expiry interval from 0 to 2147483647 seconds","nullable":true},"hostmaster":{"type":"string","description":"Email address of the zone administrator, written in SOA RNAME format with the @ replaced by a dot, for example hostmaster.example.com.","nullable":true},"minimum":{"type":"integer","description":"Negative caching time to live from 0 to 2147483647 seconds","nullable":true},"primary":{"type":"string","description":"Primary nameserver FQDN","nullable":true},"refresh":{"type":"integer","description":"Refresh interval from 0 to 2147483647 seconds","nullable":true},"retry":{"type":"integer","description":"Retry interval from 0 to 2147483647 seconds","nullable":true},"serial":{"type":"integer","description":"Non-negative SOA serial number","nullable":true},"ttl":{"type":"integer","description":"Time to live of the SOA record. From 0 to 2147483647 seconds.","nullable":true}}},"dns.gslb.ZoneRefreshResult":{"type":"object","description":"Result of refreshing a GSLB hosted zone on the name servers","properties":{"message":{"type":"string","description":"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`.","nullable":true,"readOnly":true},"recordSetCount":{"type":"integer","description":"Number of DNS resource record sets sent to the name servers, counting each name and type once and including SOA and NS","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dns.gslb.SyncStatusEnum"}],"description":"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","readOnly":true},"zone":{"type":"string","description":"Hosted zone name","readOnly":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/zone":{"get":{"operationId":"getAllGslbZones","summary":"List GSLB hosted zones","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"}}}},{"in":"query","name":"name","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dns.gslb.HostedZoneWithIAM"}}}}},"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","Zones@@@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/zone\")\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/zone\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/get","required":true}],"x-expanded-response":"DnsGslbHostedZoneWithIAM"},"post":{"operationId":"createGslbZone","summary":"Create a GSLB hosted zone with SOA and NS records","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.CreateHostedZoneRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HostedZone"}}}},"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}}"}}}}}},"409":{"description":"Error 409 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::Conflict::AccountQuotaExceeded":{"value":{"class":"Client::Conflict::AccountQuotaExceeded","message":"The GSLB alpha does not accept new accounts for now."}},"Client::Conflict::HostedZoneAlreadyExists":{"value":{"class":"Client::Conflict::HostedZoneAlreadyExists","message":"Your hosted zone already exists."}},"Client::Conflict::HostedZoneQuotaExceeded":{"value":{"class":"Client::Conflict::HostedZoneQuotaExceeded","message":"Your account has reached the maximum of {{.max}} hosted zones."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Zones@@@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.CreateHostedZoneRequest\nresult = client.post(\"/v2/dns/gslb/zone\",\n\tcomment = None, # Optional description. At most 256 characters. (type: string, nullable)\n\tname = None, # Fully qualified domain name with a trailing dot. Immutable after creation. At most 254 characters. (type: string)\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.CreateHostedZoneRequest\n$result = $ovh->post(\"/v2/dns/gslb/zone\", array(\n\tcomment => null, // Optional description. At most 256 characters. (type: string, nullable)\n\tname => null, // Fully qualified domain name with a trailing dot. Immutable after creation. At most 254 characters. (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/create","required":true}]}},"/dns/gslb/zone/{zoneId}":{"delete":{"operationId":"deleteGslbZone","summary":"Delete an empty GSLB hosted zone","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"zoneId","description":"Zone ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Global LB","Zones@@@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/zone/{zoneId}\")\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/zone/{zoneId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/delete","required":true}]},"get":{"operationId":"getGslbZone","summary":"Get a GSLB hosted zone","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"zoneId","description":"Zone ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HostedZoneWithIAM"}}}},"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::HostedZoneNotFound":{"value":{"class":"Client::NotFound::HostedZoneNotFound","message":"Your hosted zone was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Zones@@@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/zone/{zoneId}\")\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/zone/{zoneId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/get","required":true}]},"patch":{"operationId":"updateGslbZone","summary":"Update a GSLB hosted zone, including its SOA configuration","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"zoneId","description":"Zone ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.UpdateHostedZoneRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.HostedZone"}}}},"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::HostedZoneNotFound":{"value":{"class":"Client::NotFound::HostedZoneNotFound","message":"Your hosted zone was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Zones@@@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.UpdateHostedZoneRequest\nresult = client.patch(\"/v2/dns/gslb/zone/{zoneId}\",\n\tcomment = None, # New description. When omitted, the current comment is kept. When null, the comment is removed. At most 256 characters. (type: string, nullable)\n\tnameServers = None, # 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. (type: array, nullable)\n\tsoa = None, # Partial update of the zone SOA configuration. When omitted, the current SOA is kept. A null value is rejected. The SOA cannot be removed. (type: dns.gslb.UpdateSoaRequest, 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.UpdateHostedZoneRequest\n$result = $ovh->patch(\"/v2/dns/gslb/zone/{zoneId}\", array(\n\tcomment => null, // New description. When omitted, the current comment is kept. When null, the comment is removed. At most 256 characters. (type: string, nullable)\n\tnameServers => null, // 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. (type: array, nullable)\n\tsoa => null, // Partial update of the zone SOA configuration. When omitted, the current SOA is kept. A null value is rejected. The SOA cannot be removed. (type: dns.gslb.UpdateSoaRequest, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/edit","required":true}]}},"/dns/gslb/zone/{zoneId}/refresh":{"post":{"operationId":"refreshGslbZone","summary":"Push the hosted zone and its record sets again to all GSLB name servers","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"zoneId","description":"Zone ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns.gslb.ZoneRefreshResult"}}}},"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::HostedZoneNotFound":{"value":{"class":"Client::NotFound::HostedZoneNotFound","message":"Your hosted zone was not found."}}}}}}},"x-developer-hub-navigation":[["Network","Global LB","Zones@@@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.post(\"/v2/dns/gslb/zone/{zoneId}/refresh\")\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->post(\"/v2/dns/gslb/zone/{zoneId}/refresh\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"gslbZone:apiovh:zone/refresh","required":true}]}}}}
