{"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.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"domain.Domain":{"type":"object","description":"A domain name resource","properties":{"checksum":{"type":"string","description":"Computed hash used to control concurrent modification requests. Here, it represents the current target specification value."},"currentState":{"allOf":[{"$ref":"#/components/schemas/domain.DomainCurrentState"}],"description":"Current state of the domain name","readOnly":true},"currentTasks":{"type":"array","description":"Ongoing asynchronous tasks related to the domain name resource","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource. Here, the domain name itself is used as an identifier.","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Reflects the readiness of the domain name resource. A new target specification request will be accepted only in `READY`, `UPDATING` or `ERROR` status.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/domain.DomainTargetSpec"}],"description":"Latest target specification of the domain name resource"}},"required":["targetSpec"]},"domain.DomainCurrentState":{"type":"object","description":"Current state of the domain name","properties":{"additionalStates":{"type":"array","description":"Additional states of your domain","items":{"$ref":"#/components/schemas/domain.resource.currentState.AdditionalStatesEnum"},"readOnly":true},"authInfoManagedByOVHcloud":{"type":"boolean","description":"Whether OVHcloud manages your authinfo","nullable":true,"readOnly":true},"authInfoSupported":{"type":"boolean","description":"Whether the registry uses authinfo to secure your domain name","readOnly":true},"contactsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.ContactsConfiguration"}],"description":"Configuration of your domain contacts","readOnly":true},"createdAt":{"type":"string","description":"Date when your domain name was created","nullable":true,"format":"date-time","readOnly":true},"designatedAgentAllowed":{"type":"boolean","description":"Whether a Designated Agent may validate the trade operations (change of holder) for this domain","readOnly":true},"dnsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.DnsConfiguration"}],"description":"DNS configuration of your domain","readOnly":true},"dnssecConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.DnssecConfiguration"}],"description":"DNSSEC configuration of your domain","readOnly":true},"extension":{"type":"string","description":"Extension of your domain name","readOnly":true},"hostsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.HostsConfiguration"}],"description":"Host configuration of your domain","readOnly":true},"mainState":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.MainStateEnum"}],"description":"Main state of your domain","readOnly":true},"name":{"type":"string","description":"Your domain name","readOnly":true},"protectionState":{"allOf":[{"$ref":"#/components/schemas/domain.resource.ProtectionStateEnum"}],"description":"Protection state of your domain","readOnly":true},"suspensionState":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.SuspensionStateEnum"}],"description":"Suspension state of your domain","readOnly":true},"transferAuthorizationMethod":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.TransferAuthorizationMethodEnum"}],"description":"Method used to authorize domain transfer","readOnly":true}}},"domain.DomainTargetSpec":{"type":"object","description":"Specifies the target configuration for your domain name service","properties":{"contactsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.ContactsConfiguration"}],"description":"Provides the configuration for your domain contacts","nullable":true},"dnsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.DnsConfiguration"}],"description":"Provides the DNS configuration for your domain","nullable":true},"dnssecConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.DnssecConfiguration"}],"description":"Provides the DNSSEC configuration for your domain","nullable":true},"hostsConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.HostsConfiguration"}],"description":"Provides the host configuration for your domain","nullable":true},"protectionState":{"allOf":[{"$ref":"#/components/schemas/domain.resource.ProtectionStateEnum"}],"description":"Indicates the protection state of your domain","nullable":true}}},"domain.DomainWithIAM":{"type":"object","description":"A domain name resource","properties":{"checksum":{"type":"string","description":"Computed hash used to control concurrent modification requests. Here, it represents the current target specification value."},"currentState":{"allOf":[{"$ref":"#/components/schemas/domain.DomainCurrentState"}],"description":"Current state of the domain name","readOnly":true},"currentTasks":{"type":"array","description":"Ongoing asynchronous tasks related to the domain name resource","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"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 resource. Here, the domain name itself is used as an identifier.","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Reflects the readiness of the domain name resource. A new target specification request will be accepted only in `READY`, `UPDATING` or `ERROR` status.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/domain.DomainTargetSpec"}],"description":"Latest target specification of the domain name resource"}},"required":["targetSpec"]},"domain.resource.DisclosedFieldsEnum":{"type":"string","description":"The fields that can be displayed in plain text via RDDS","enum":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"]},"domain.resource.DisclosureConfigurationEnum":{"type":"string","description":"Authorized disclosure configurations","enum":["DISCLOSED","REDACTED"]},"domain.resource.ProtectionStateEnum":{"type":"string","description":"Authorized values for protectionState field","enum":["PROTECTED","UNPROTECTED"]},"domain.resource.currentState.AdditionalStatesEnum":{"type":"string","description":"Authorized values for additionalStates field","enum":["DGCCRF_ABUSE","DISPUTE","FORCED_DELETION","OVH_ABUSE","REGISTRY_ABUSE","TECHNICAL_SUSPENDED"]},"domain.resource.currentState.AlgorithmNameEnum":{"type":"string","description":"The list of supported cryptographic algorithms for DNSSEC keys","enum":["DSA","DSA-NSEC3-SHA1","ECC-GOST","ECDSAP256SHA256","ECDSAP384SHA384","ED25519","ED448","RSASHA1","RSASHA1-NSEC3-SHA1","RSASHA256","RSASHA512"]},"domain.resource.currentState.ContactsConfiguration":{"type":"object","description":"Overview of the contacts related to the domain name","properties":{"contactAdministrator":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.contactsConfiguration.ContactConfiguration"}],"description":"The configuration of the administrator contact","readOnly":true},"contactBilling":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.contactsConfiguration.ContactConfiguration"}],"description":"The configuration of the billing contact","readOnly":true},"contactOwner":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.contactsConfiguration.ContactConfiguration"}],"description":"The configuration of the owner contact","readOnly":true},"contactTechnical":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.contactsConfiguration.ContactConfiguration"}],"description":"The configuration of the technical contact","readOnly":true}}},"domain.resource.currentState.DnsConfiguration":{"type":"object","description":"Information about the domain DNS configuration","properties":{"configurationType":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.dnsConfiguration.NameServerTypeEnum"}],"description":"Specifies the DNS configuration type for your domain","readOnly":true},"dnssecSupported":{"type":"boolean","description":"Deprecated. Use `dnssecSupported` from dnssecConfiguration node instead.","readOnly":true},"glueRecordIPv6Supported":{"type":"boolean","description":"Deprecated. Use `ipv6Supported` from hostsConfiguration instead.","readOnly":true},"hostSupported":{"type":"boolean","description":"Deprecated. Use `hostSupported` from hostsConfiguration instead.","readOnly":true},"maxDNS":{"type":"integer","description":"Specifies the maximum number of name servers allowed by the registry","readOnly":true},"minDNS":{"type":"integer","description":"Specifies the minimum number of name servers allowed by the registry","readOnly":true},"multipleIPsSupported":{"type":"boolean","description":"Whether the registry accepts more than one address on a name server, IPv4 and IPv6 counted together: one of each already counts as several","nullable":true,"readOnly":true},"nameServers":{"type":"array","description":"Lists the name servers used by your domain","items":{"$ref":"#/components/schemas/domain.resource.currentState.dnsConfiguration.NameServer"},"readOnly":true}}},"domain.resource.currentState.DnssecConfiguration":{"type":"object","description":"Provides information about the domain's DNSSEC configuration","properties":{"dnssecSupported":{"type":"boolean","description":"Whether the registry supports DNSSEC","readOnly":true},"dsData":{"type":"array","description":"Contains the registered DS data for your domain name","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.currentState.dnssecConfiguration.DsData"},"readOnly":true},"supportedAlgorithms":{"type":"array","description":"Specifies all cryptographic algorithms that you can use to define DS data","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.currentState.dnssecConfiguration.SupportedAlgorithm"},"readOnly":true}}},"domain.resource.currentState.HostsConfiguration":{"type":"object","description":"Information about the domain host configuration","properties":{"hostSupported":{"type":"boolean","description":"Whether the registry supports host management","readOnly":true},"hosts":{"type":"array","description":"Contains the registered host configuration","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.currentState.hostsConfiguration.Host"},"readOnly":true},"ipv4Supported":{"type":"boolean","description":"Whether the registry supports IPv4","nullable":true,"readOnly":true},"ipv6Supported":{"type":"boolean","description":"Whether the registry supports IPv6","nullable":true,"readOnly":true},"multipleIPsSupported":{"type":"boolean","description":"Whether the registry supports multiple IPs","nullable":true,"readOnly":true}}},"domain.resource.currentState.MainStateEnum":{"type":"string","description":"Authorized values for mainState field","enum":["DELETED","EXPIRED","OK","PENDING_CREATE","PENDING_DELETE","PENDING_INTERNAL_TRANSFER","PENDING_OUTGOING_TRANSFER","RESTORABLE","TO_DELETE"]},"domain.resource.currentState.SuspensionStateEnum":{"type":"string","description":"Authorized values for suspensionState field","enum":["NOT_SUSPENDED","SUSPENDED"]},"domain.resource.currentState.TransferAuthorizationMethodEnum":{"type":"string","description":"Authorized values for transferAuthorizationMethod field","enum":["ASK_OVHCLOUD_SUPPORT","AUTH_CODE","NONE","TRANSFER_TAG"]},"domain.resource.currentState.contactsConfiguration.ContactConfiguration":{"type":"object","description":"The configuration of the contact","properties":{"disclosurePolicy":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.contactsConfiguration.contactConfiguration.DisclosurePolicy"}],"description":"The data disclosure policy of the contact","readOnly":true},"id":{"type":"string","description":"Identifier of the contact","readOnly":true}}},"domain.resource.currentState.contactsConfiguration.contactConfiguration.DisclosurePolicy":{"type":"object","description":"Information about the disclosure policy of a contact","properties":{"disclosedFields":{"type":"array","description":"The fields that will be displayed in plain text if the configuration is disclosed","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.DisclosedFieldsEnum"},"readOnly":true},"disclosureConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.DisclosureConfigurationEnum"}],"description":"Whether the contact data are disclosed or redacted","nullable":true,"readOnly":true},"forcedDisclosureConfiguration":{"type":"boolean","description":"Whether the configuration is forced by the registry","nullable":true,"readOnly":true},"visibleViaRdds":{"type":"boolean","description":"Whether the contact is visible via RDDS (displayed in WHOIS and RDAP directories)","readOnly":true}}},"domain.resource.currentState.dnsConfiguration.NameServer":{"type":"object","description":"Information about a name server","properties":{"ips":{"type":"array","description":"IP addresses associated to the name server","nullable":true,"items":{"$ref":"#/components/schemas/ip"},"readOnly":true},"ipv4":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Deprecated. Use `ips` instead, which carries every address of the name server.","nullable":true,"readOnly":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"Deprecated. Use `ips` instead, which carries every address of the name server.","nullable":true,"readOnly":true},"nameServer":{"type":"string","description":"The host name","readOnly":true},"nameServerType":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.dnsConfiguration.NameServerTypeEnum"}],"description":"The type of name server","readOnly":true}}},"domain.resource.currentState.dnsConfiguration.NameServerTypeEnum":{"type":"string","description":"Possible name server types","enum":["ANYCAST","DEDICATED","EMPTY","EXTERNAL","HOLD","HOSTING","MIXED","PARKING"]},"domain.resource.currentState.dnssecConfiguration.DsData":{"type":"object","description":"Provides information about the domain DS data","properties":{"algorithm":{"type":"integer","description":"Identifies the cryptographic algorithm used for the public key","readOnly":true},"flags":{"type":"integer","description":"Indicates the type of the key, for example 257 for KSK, 256 for ZSK","readOnly":true},"keyTag":{"type":"integer","description":"Provides a unique identifier for the public key. From 0 to 65535.","readOnly":true},"publicKey":{"type":"string","description":"Contains the base64‑encoded representation of the public key","readOnly":true}}},"domain.resource.currentState.dnssecConfiguration.SupportedAlgorithm":{"type":"object","description":"Describes a supported DNSSEC algorithm with its name and corresponding number","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/domain.resource.currentState.AlgorithmNameEnum"}],"description":"Specifies the name of the cryptographic algorithm","readOnly":true},"number":{"type":"integer","description":"Specifies the numeric value of the cryptographic algorithm","readOnly":true}}},"domain.resource.currentState.hostsConfiguration.Host":{"type":"object","description":"Information about a host","properties":{"host":{"type":"string","description":"The host name","nullable":true,"readOnly":true},"ips":{"type":"array","description":"IPs linked to a host","nullable":true,"items":{"$ref":"#/components/schemas/ip"},"readOnly":true}}},"domain.resource.targetSpec.ContactsConfiguration":{"type":"object","description":"Provides the configuration of the domain contacts","properties":{"contactAdministrator":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.ContactConfiguration"}],"description":"Indicates the configuration of the administrator contact","nullable":true},"contactBilling":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.ContactConfiguration"}],"description":"Indicates the configuration of the billing contact","nullable":true},"contactOwner":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.OwnerConfiguration"}],"description":"Indicates the configuration of the owner contact","nullable":true},"contactTechnical":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.ContactConfiguration"}],"description":"Indicates the configuration of the technical contact","nullable":true}}},"domain.resource.targetSpec.DnsConfiguration":{"type":"object","description":"Provides information about the domain DNS configuration","properties":{"nameServers":{"type":"array","description":"The name servers to update","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.targetSpec.dnsConfiguration.NameServer"}}}},"domain.resource.targetSpec.DnssecConfiguration":{"type":"object","description":"Provides information about the domain's DNSSEC configuration","properties":{"dsData":{"type":"array","description":"Contains the DS data to update","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.targetSpec.dnssecConfiguration.DsData"}}}},"domain.resource.targetSpec.HostsConfiguration":{"type":"object","description":"Provides information about the domain hosts configuration","properties":{"hosts":{"type":"array","description":"The hosts you update","nullable":true,"items":{"$ref":"#/components/schemas/domain.resource.targetSpec.hostsConfiguration.Host"}}}},"domain.resource.targetSpec.contactsConfiguration.ContactConfiguration":{"type":"object","description":"Configuration of the administator, billing and technical contacts","properties":{"disclosurePolicy":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.contactConfiguration.DisclosurePolicy"}],"description":"Indicates the data disclosure policy of the contact"}}},"domain.resource.targetSpec.contactsConfiguration.OwnerConfiguration":{"type":"object","description":"Configuration for the owner contact","properties":{"disclosurePolicy":{"allOf":[{"$ref":"#/components/schemas/domain.resource.targetSpec.contactsConfiguration.contactConfiguration.DisclosurePolicy"}],"description":"Indicates the data disclosure policy of the contact","nullable":true},"id":{"type":"string","description":"Identifier of the contact","nullable":true}}},"domain.resource.targetSpec.contactsConfiguration.contactConfiguration.DisclosurePolicy":{"type":"object","description":"Information about the disclosure policy of a contact","properties":{"disclosureConfiguration":{"allOf":[{"$ref":"#/components/schemas/domain.resource.DisclosureConfigurationEnum"}],"description":"Indicates whether the contact data are disclosed or redacted"}},"required":["disclosureConfiguration"]},"domain.resource.targetSpec.dnsConfiguration.NameServer":{"type":"object","description":"Information about a name server","properties":{"ips":{"type":"array","description":"IP addresses of the name server","nullable":true,"items":{"$ref":"#/components/schemas/ip"}},"ipv4":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Deprecated. Use `ips` instead, which carries every address of the name server.","nullable":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"Deprecated. Use `ips` instead, which carries every address of the name server.","nullable":true},"nameServer":{"type":"string","description":"Host name of the name server"}},"required":["nameServer"]},"domain.resource.targetSpec.dnssecConfiguration.DsData":{"type":"object","description":"The DS data used in your DNSSEC configuration","properties":{"algorithm":{"type":"integer","description":"Identifies the cryptographic algorithm used for the public key"},"flags":{"type":"integer","description":"Indicates the type of the key, for example 257 for KSK, 256 for ZSK"},"keyTag":{"type":"integer","description":"Provides a unique identifier for the public key. From 0 to 65535."},"publicKey":{"type":"string","description":"Contains the base64‑encoded representation of the public key"}},"required":["algorithm","flags","keyTag","publicKey"]},"domain.resource.targetSpec.hostsConfiguration.Host":{"type":"object","description":"Provides information about a host","properties":{"host":{"type":"string","description":"Specifies the host name"},"ips":{"type":"array","description":"Lists the IP addresses linked to the host","items":{"$ref":"#/components/schemas/ip"}}},"required":["host","ips"]},"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":{"/domain/name":{"get":{"operationId":"getAllDomainNames","summary":"List all domain name resources","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":"additionalStates","description":"Filter the results having all these additional states","schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.resource.currentState.AdditionalStatesEnum"}}},{"in":"query","name":"contactAdministrator","description":"Filter the results by administrator contact id","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"contactBilling","description":"Filter the results by billing contact id","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"contactOwner","description":"Filter the results by owner contact id","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"contactTechnical","description":"Filter the results by technical contact id","schema":{"type":"array","items":{"type":"string"}}},{"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":"mainState","description":"Filter the results having all these main states","schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.resource.currentState.MainStateEnum"}}},{"in":"query","name":"searchValue","description":"Filter the results with the search value on resource id","schema":{"type":"string"}},{"in":"query","name":"suspensionState","description":"Filter the results having all these suspension states","schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.resource.currentState.SuspensionStateEnum"}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.DomainWithIAM"}},"examples":{"List all domain name resources":{"value":[{"checksum":"4b9e9b9ddb80d5f9d6e304a95961ea2b","currentState":{"additionalStates":[],"authInfoManagedByOVHcloud":false,"authInfoSupported":true,"contactsConfiguration":{"contactAdministrator":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"},"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED","visibleViaRdds":true},"id":"ab1234-ovh"},"contactOwner":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","visibleViaRdds":true},"id":"5f9ce5c1-8ac6-4aed-8907-98b961c9446e"},"contactTechnical":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","forcedDisclosureConfiguration":true,"visibleViaRdds":true},"id":"ab1234-ovh"}},"createdAt":"2020-11-12T17:10:19+01:00","designatedAgentAllowed":false,"dnsConfiguration":{"configurationType":"MIXED","dnssecSupported":true,"glueRecordIPv6Supported":true,"hostSupported":true,"maxDNS":8,"minDNS":2,"multipleIPsSupported":true,"nameServers":[{"nameServer":"ns1.ovh.net","nameServerType":"HOSTING"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr","nameServerType":"EXTERNAL"}]},"dnssecConfiguration":{"dnssecSupported":true,"dsData":[{"algorithm":3,"flags":257,"keyTag":34073,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"},{"algorithm":5,"flags":257,"keyTag":34075,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}],"supportedAlgorithms":[{"name":"RSASHA1","number":5},{"name":"RSASHA1-NSEC3-SHA1","number":7},{"name":"RSASHA256","number":8},{"name":"RSASHA512","number":10},{"name":"ECDSAP256SHA256","number":13},{"name":"ECDSAP384SHA384","number":14},{"name":"ED25519","number":15}]},"extension":"fr","hostsConfiguration":{"hostSupported":true,"hosts":[{"host":"ns4.example.fr","ips":["1.0.0.0"]},{"host":"ns5.example.fr","ips":["2001:0000:130D:0000:0000:09C0:876A:543B"]},{"host":"ns6.example.fr","ips":["3.3.3.3","2001:0000:130D:0000:0000:09C0:876A:543B"]}],"ipv4Supported":true,"ipv6Supported":true,"multipleIPsSupported":true},"mainState":"OK","name":"example.fr","protectionState":"PROTECTED","suspensionState":"NOT_SUSPENDED","transferAuthorizationMethod":"AUTH_CODE"},"currentTasks":[],"id":"example.fr","resourceStatus":"READY","targetSpec":{"contactsConfiguration":{"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED"}},"contactOwner":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"},"id":"5f9ce5c1-8ac6-4aed-8907-98b961c9446e"},"contactTechnical":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}}},"dnsConfiguration":{"nameServers":[{"nameServer":"ns1.ovh.net"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr"}]},"dnssecConfiguration":{"dsData":[{"algorithm":3,"flags":257,"keyTag":34073,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"},{"algorithm":5,"flags":257,"keyTag":34075,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}]},"hostsConfiguration":{"hosts":[{"host":"ns4.example.fr","ips":["1.0.0.0"]},{"host":"ns5.example.fr","ips":["2001:0000:130D:0000:0000:09C0:876A:543B"]},{"host":"ns6.example.fr","ips":["3.3.3.3","2001:0000:130D:0000:0000:09C0:876A:543B"]}]},"protectionState":"PROTECTED"}},{"checksum":"4b9e9b9ddb80d5f9d6e304a95961eb3a","currentState":{"additionalStates":["DISPUTE","TECHNICAL_SUSPENDED"],"authInfoManagedByOVHcloud":true,"authInfoSupported":true,"contactsConfiguration":{"contactAdministrator":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"},"contactBilling":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"},"contactOwner":{"disclosurePolicy":{"visibleViaRdds":false},"id":"dfed15bc-4c7f-4359-82ce-f71d05c4fd14"},"contactTechnical":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"}},"createdAt":"2020-11-12T17:10:19+01:00","designatedAgentAllowed":true,"dnsConfiguration":{"configurationType":"HOSTING","dnssecSupported":true,"glueRecordIPv6Supported":true,"hostSupported":true,"maxDNS":14,"minDNS":0,"multipleIPsSupported":true,"nameServers":[{"nameServer":"ns1.ovh.net","nameServerType":"HOSTING"},{"nameServer":"ns2.ovh.net","nameServerType":"HOSTING"}]},"dnssecConfiguration":{"dnssecSupported":false},"extension":"com","hostsConfiguration":{"hostSupported":false},"mainState":"PENDING_DELETE","name":"example.com","protectionState":"PROTECTED","suspensionState":"SUSPENDED","transferAuthorizationMethod":"AUTH_CODE"},"currentTasks":[],"id":"example.fr","resourceStatus":"DELETING","targetSpec":{"contactsConfiguration":{"contactOwner":{"id":"dfed15bc-4c7f-4359-82ce-f71d05c4fd14"}},"dnsConfiguration":{"nameServers":[{"nameServer":"ns1.ovh.net"},{"nameServer":"ns2.ovh.net"}]},"protectionState":"PROTECTED"}}],"summary":"Response body returned when listing domain names"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains@@@10"]],"x-badges":[{"color":"blue","label":"Beta 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/domain/name\")\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/domain/name\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/get","required":true}],"x-expanded-response":"DomainDomainWithIAM"}},"/domain/name/{domainName}":{"get":{"operationId":"getDomainName","summary":"Get a domain name resource","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.DomainWithIAM"},"examples":{"Get a domain name resource":{"value":{"checksum":"4b9e9b9ddb80d5f9d6e304a95961ea2b","currentState":{"additionalStates":[],"authInfoManagedByOVHcloud":false,"authInfoSupported":true,"contactsConfiguration":{"contactAdministrator":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"},"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED","forcedDisclosureConfiguration":false,"visibleViaRdds":true},"id":"ab1234-ovh"},"contactOwner":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","forcedDisclosureConfiguration":false,"visibleViaRdds":true},"id":"5f9ce5c1-8ac6-4aed-8907-98b961c9446e"},"contactTechnical":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","forcedDisclosureConfiguration":true,"visibleViaRdds":true},"id":"ab1234-ovh"}},"createdAt":"2020-11-12T17:10:19+01:00","designatedAgentAllowed":false,"dnsConfiguration":{"configurationType":"MIXED","dnssecSupported":true,"glueRecordIPv6Supported":true,"hostSupported":true,"maxDNS":8,"minDNS":2,"multipleIPsSupported":true,"nameServers":[{"nameServer":"ns1.ovh.net","nameServerType":"HOSTING"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr","nameServerType":"EXTERNAL"}]},"dnssecConfiguration":{"dnssecSupported":true,"dsData":[{"algorithm":3,"flags":257,"keyTag":34073,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"},{"algorithm":5,"flags":257,"keyTag":34075,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}],"supportedAlgorithms":[{"name":"RSASHA1","number":5},{"name":"RSASHA1-NSEC3-SHA1","number":7},{"name":"RSASHA256","number":8},{"name":"RSASHA512","number":10},{"name":"ECDSAP256SHA256","number":13},{"name":"ECDSAP384SHA384","number":14},{"name":"ED25519","number":15}]},"extension":"fr","hostsConfiguration":{"hostSupported":true,"hosts":[{"host":"ns4.example.fr","ips":["1.0.0.0"]},{"host":"ns5.example.fr","ips":["2001:0000:130D:0000:0000:09C0:876A:543B"]},{"host":"ns6.example.fr","ips":["3.3.3.3","2001:0000:130D:0000:0000:09C0:876A:543B"]}],"ipv4Supported":true,"ipv6Supported":true,"multipleIPsSupported":true},"mainState":"OK","name":"example.fr","protectionState":"PROTECTED","suspensionState":"NOT_SUSPENDED","transferAuthorizationMethod":"AUTH_CODE"},"currentTasks":[],"id":"example.fr","resourceStatus":"READY","targetSpec":{"contactsConfiguration":{"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED"}},"contactOwner":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"},"id":"5f9ce5c1-8ac6-4aed-8907-98b961c9446e"},"contactTechnical":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}}},"dnsConfiguration":{"nameServers":[{"nameServer":"ns1.ovh.net"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr"}]},"dnssecConfiguration":{"dsData":[{"algorithm":3,"flags":257,"keyTag":34073,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"},{"algorithm":5,"flags":257,"keyTag":34075,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}]},"hostsConfiguration":{"hosts":[{"host":"ns4.example.fr","ips":["1.0.0.0"]},{"host":"ns5.example.fr","ips":["2001:0000:130D:0000:0000:09C0:876A:543B"]},{"host":"ns6.example.fr","ips":["3.3.3.3","2001:0000:130D:0000:0000:09C0:876A:543B"]}]},"protectionState":"PROTECTED"}},"summary":"Retrieve the given domain name"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains@@@20"]],"x-badges":[{"color":"blue","label":"Beta 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/domain/name/{domainName}\")\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/domain/name/{domainName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/get","required":true}]},"put":{"operationId":"editDomainName","summary":"Update an existing domain name by modifying various configurations through the targetSpec","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.Domain"},"examples":{"Update the domain resource":{"value":{"checksum":"4b9e9b9ddb80d5f9d6e304a95961ea2b","targetSpec":{"contactsConfiguration":{"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}},"contactOwner":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED"},"id":"e66c33b1-22ee-486f-898b-e737cc3019f0"},"contactTechnical":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}}},"dnsConfiguration":{"nameServers":[{"ipv4":"1.2.3.4","nameServer":"ns2.example.fr"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr"}]},"dnssecConfiguration":{"dsData":[{"algorithm":7,"flags":257,"keyTag":34077,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}]},"protectionState":"PROTECTED"}},"summary":"Update an existing domain name by modifying several configurations at the same time"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.Domain"},"examples":{"Update the domain name's nameservers and owner contact":{"value":{"checksum":"4b9e9b9ddb80d5f9f4e304a95961ea2b","currentState":{"additionalStates":[],"authInfoManagedByOVHcloud":false,"authInfoSupported":true,"contactsConfiguration":{"contactAdministrator":{"disclosurePolicy":{"visibleViaRdds":false},"id":"ab1234-ovh"},"contactBilling":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","forcedDisclosureConfiguration":false,"visibleViaRdds":true},"id":"ab1234-ovh"},"contactOwner":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED","forcedDisclosureConfiguration":false,"visibleViaRdds":true},"id":"12345678"},"contactTechnical":{"disclosurePolicy":{"disclosedFields":["ADDRESS","CITY","COUNTRY","EMAIL","FAX","NAME","ORGANIZATION","PHONE","PROVINCE","ZIP"],"disclosureConfiguration":"DISCLOSED","forcedDisclosureConfiguration":true,"visibleViaRdds":true},"id":"ab1234-ovh"}},"createdAt":"2020-11-12T17:10:19+01:00","designatedAgentAllowed":false,"dnsConfiguration":{"configurationType":"MIXED","dnssecSupported":true,"glueRecordIPv6Supported":true,"hostSupported":true,"maxDNS":8,"minDNS":2,"multipleIPsSupported":true,"nameServers":[{"nameServer":"ns1.ovh.net","nameServerType":"HOSTING"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr","nameServerType":"EXTERNAL"}]},"dnssecConfiguration":{"dnssecSupported":true,"dsData":[{"algorithm":3,"flags":257,"keyTag":34073,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"},{"algorithm":5,"flags":257,"keyTag":34075,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}],"supportedAlgorithms":[{"name":"RSASHA1","number":5},{"name":"RSASHA1-NSEC3-SHA1","number":7},{"name":"RSASHA256","number":8},{"name":"RSASHA512","number":10},{"name":"ECDSAP256SHA256","number":13},{"name":"ECDSAP384SHA384","number":14},{"name":"ED25519","number":15}]},"extension":"fr","hostsConfiguration":{"hostSupported":true,"hosts":[{"host":"ns4.example.fr","ips":["1.0.0.0"]},{"host":"ns5.example.fr","ips":["2001:0000:130D:0000:0000:09C0:876A:543B"]},{"host":"ns6.example.fr","ips":["3.3.3.3","2001:0000:130D:0000:0000:09C0:876A:543B"]}],"ipv4Supported":true,"ipv6Supported":true,"multipleIPsSupported":true},"mainState":"OK","name":"example.fr","protectionState":"PROTECTED","suspensionState":"NOT_SUSPENDED","transferAuthorizationMethod":"AUTH_CODE"},"currentTasks":[{"id":"18647459-b260-4000-8b85-55c315152902","link":"v2/domain/name/example.org/task/18647459-b260-4000-8b85-55c315152902","status":"PENDING","type":"DomainDnsUpdate"},{"id":"a656cbbc-12dd-48b1-a8b1-6f09ac7d1aa1","link":"v2/domain/name/example.org/task/a656cbbc-12dd-48b1-a8b1-6f09ac7d1aa1","status":"PENDING","type":"DomainContactUpdate"},{"id":"a656cbbc-12dd-48b1-a8b1-6f09ac7d1aa3","link":"v2/domain/name/example.org/task/a656cbbc-12dd-48b1-a8b1-6f09ac7d1aa3","status":"PENDING","type":"DomainDsUpdate"}],"id":"example.fr","resourceStatus":"UPDATING","targetSpec":{"contactsConfiguration":{"contactBilling":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}},"contactOwner":{"disclosurePolicy":{"disclosureConfiguration":"REDACTED"},"id":"e66c33b1-22ee-486f-898b-e737cc3019f0"},"contactTechnical":{"disclosurePolicy":{"disclosureConfiguration":"DISCLOSED"}}},"dnsConfiguration":{"nameServers":[{"ipv4":"1.2.3.4","nameServer":"ns2.example.fr"},{"ipv6":"2001:0000:130F:0000:0000:09C0:876A:130B","nameServer":"ns1.example.fr"}]},"dnssecConfiguration":{"dsData":[{"algorithm":7,"flags":257,"keyTag":34077,"publicKey":"AwEAAaFakeBase64PublicKeyForKSKExampleqwertyuiopasdfghjklzxcvbnm1234567890ABCDEFG"}]}}},"summary":"Response body when updating the domain name"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains@@@30"]],"x-badges":[{"color":"blue","label":"Beta 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: domain.Domain\nresult = client.put(\"/v2/domain/name/{domainName}\",\n\tchecksum = None, # Computed hash used to control concurrent modification requests. Here, it represents the current target specification value. (type: string)\n\ttargetSpec = None, # Latest target specification of the domain name resource (type: domain.DomainTargetSpec)\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: domain.Domain\n$result = $ovh->put(\"/v2/domain/name/{domainName}\", array(\n\tchecksum => null, // Computed hash used to control concurrent modification requests. Here, it represents the current target specification value. (type: string)\n\ttargetSpec => null, // Latest target specification of the domain name resource (type: domain.DomainTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/edit","required":true},{"name":"domain:apiovh:name/setProtection","description":"Only domain admin can lock or unlock domain","required":false}]}}}}