{"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/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"domain.ActionEnum":{"type":"string","description":"An action to execute on a domain name","enum":["create","trade","transfer","update"]},"domain.Contact":{"type":"object","description":"A contact contains the personal data of a user","properties":{"accreditationCountry":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Country of lawyer accreditation","nullable":true},"accreditationId":{"type":"string","description":"Lawyer accreditation number","nullable":true},"accreditationOrganism":{"type":"string","description":"Organism of lawyer accreditation","nullable":true},"accreditationYear":{"type":"integer","description":"Year of lawyer accreditation","nullable":true},"address":{"allOf":[{"$ref":"#/components/schemas/domain.ContactAddress"}],"description":"The address of the contact","nullable":true},"birthCity":{"type":"string","description":"City of birth","nullable":true},"birthCountry":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Birth Country","nullable":true},"birthDay":{"type":"string","description":"Birth date","nullable":true,"format":"date"},"birthZip":{"type":"string","description":"Birth Zipcode","nullable":true},"cellPhone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Cellphone number","nullable":true},"companyNationalIdentificationNumber":{"type":"string","description":"Company National Identification Number","nullable":true},"email":{"type":"string","description":"Email address","nullable":true},"enterpriseId":{"type":"string","description":"Enterprise identifier","nullable":true},"fax":{"type":"string","description":"Fax number","nullable":true},"firstName":{"type":"string","description":"First name","nullable":true},"gender":{"allOf":[{"$ref":"#/components/schemas/nichandle.GenderEnum"}],"description":"Gender","nullable":true},"id":{"type":"integer","description":"Unique identifier","readOnly":true},"insee":{"type":"string","description":"INSEE identifier","nullable":true},"language":{"allOf":[{"$ref":"#/components/schemas/nichandle.LanguageEnum"}],"description":"Language","nullable":true},"lastName":{"type":"string","description":"Last name","nullable":true},"legalForm":{"allOf":[{"$ref":"#/components/schemas/nichandle.LegalFormEnum"}],"nullable":true},"legalFormCategory":{"type":"string","description":"category of legalForm","nullable":true},"nationalIdentificationNumber":{"type":"string","description":"National Identification Number","nullable":true},"nationality":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Nationality","nullable":true},"organisationAccountable":{"type":"string","description":"To whom is the organisation accountable","nullable":true},"organisationFunding":{"type":"string","description":"What is the source of funding","nullable":true},"organisationFundingOther":{"type":"string","description":"Explain the source of funding if organisationFunding is other","nullable":true},"organisationName":{"type":"string","description":"Name of organisation","nullable":true},"organisationRole":{"type":"string","description":"Role of your organisation","nullable":true},"organisationRoleOther":{"type":"string","description":"Explain the role of your organisation if organisationRole is other","nullable":true},"organisationStaffStatus":{"type":"string","description":"Status of the staff","nullable":true},"organisationStaffStatusOther":{"type":"string","description":"Explain the status of the staff if organisationStaffStatus is other","nullable":true},"organisationType":{"type":"string","description":"type of organisation","nullable":true},"organisationTypeOther":{"type":"string","description":"Explain the type of organisation if organisationType is other","nullable":true},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Phone number","nullable":true},"registrantDocumentType":{"type":"string","description":"Type of registrant document","nullable":true},"registrantDocumentTypeOther":{"type":"string","description":"Explain the type of registrant document if registrantDocumentType is other","nullable":true},"roleInOrganisation":{"type":"string","description":"The role in the organisation","nullable":true},"trademarkId":{"type":"string","description":"Trademark related to the contact","nullable":true},"vat":{"type":"string","description":"VAT number","nullable":true},"website":{"type":"string","description":"Website","nullable":true}}},"domain.ContactAddress":{"type":"object","description":"Missing description","properties":{"city":{"type":"string","description":"City","nullable":true},"country":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Country","nullable":true},"line1":{"type":"string","description":"Address line 1","nullable":true},"line2":{"type":"string","description":"Address line 2","nullable":true},"line3":{"type":"string","description":"Address line 3","nullable":true},"otherDetails":{"type":"string","description":"Others details","nullable":true},"province":{"type":"string","description":"Province","nullable":true},"zip":{"type":"string","description":"Zip code","nullable":true}}},"domain.Data":{"type":"object","description":"A domain data","properties":{"audience":{"type":"string","description":"Domain name audience","nullable":true},"authInfo":{"type":"string","description":"Auth Info","nullable":true,"format":"password"},"isFor":{"type":"array","description":"Purposes of the domain","nullable":true,"items":{"$ref":"#/components/schemas/domain.IsForEnum"}},"otherPurpose":{"type":"string","description":"Domain name other purpose","nullable":true},"reason":{"type":"string","description":"Reason of the purchase of this domain","nullable":true},"represent":{"type":"string","description":"Represented company","nullable":true}}},"domain.IsForEnum":{"type":"string","description":"Possible purposes of the domain","enum":["campaign_website","educational_website","emails","information_website","other_purpose","redirect_page","transactional_website"]},"domain.configuration.rules.Constraint":{"type":"object","description":"A configuration rule defines validation to launch when executing an action on a domain (create, trade...). Depending on the extension, the rule may be different","properties":{"conditions":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.Rule"}],"description":"Whether this constraint is applied or not","nullable":true,"readOnly":true},"contexts":{"type":"array","description":"The context on which the constraint applies","nullable":true,"items":{"$ref":"#/components/schemas/domain.configuration.rules.ContextEnum"},"readOnly":true},"operator":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.OperatorEnum"}],"description":"The operator of the constraint","nullable":true,"readOnly":true},"value":{"type":"string","description":"The value to match against","nullable":true,"readOnly":true},"values":{"type":"array","description":"The values to match against","nullable":true,"items":{"type":"string"},"readOnly":true}}},"domain.configuration.rules.ContextEnum":{"type":"string","description":"Used in rule to tell if rule (or part of the rule) is applicable for a given context","enum":["accept_conditions","claims","create","order","premium","protected_code","reason","trade","transfer","update"]},"domain.configuration.rules.OperatorEnum":{"type":"string","description":"Operator use in configuration rule to check content of a field","enum":["between","contains","empty","eq","gt","gte","lt","lte","match","maxlength","minlength","ne","notcontains","notempty","readonly","required","shouldbetrue"]},"domain.configuration.rules.Rule":{"type":"object","description":"A configuration rule defines validation to launch when executing an action on a domain (create, trade...). Depending on the extension, the rule may be different","properties":{"and":{"type":"array","description":"An \"and\" operator on multiple rules","nullable":true,"items":{"$ref":"#/components/schemas/domain.configuration.rules.Rule"},"readOnly":true},"conditions":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.Rule"}],"description":"Whether this rule is applied or not","nullable":true,"readOnly":true},"constraints":{"type":"array","description":"The constraints of the rule","nullable":true,"items":{"$ref":"#/components/schemas/domain.configuration.rules.Constraint"},"readOnly":true},"contexts":{"type":"array","description":"The context on which the rule applies","nullable":true,"items":{"$ref":"#/components/schemas/domain.configuration.rules.ContextEnum"},"readOnly":true},"description":{"type":"string","description":"The description of the rule","nullable":true,"readOnly":true},"fields":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.Rule"}],"description":"The fields with specific rules","nullable":true,"readOnly":true},"label":{"type":"string","description":"The label of the rule","nullable":true,"readOnly":true},"or":{"type":"array","description":"An \"or\" operator on multiple rules","nullable":true,"items":{"$ref":"#/components/schemas/domain.configuration.rules.Rule"},"readOnly":true},"placeholder":{"type":"string","description":"The default value used for the rule","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.TypeEnum"}],"description":"The type of the object the rule applies on","nullable":true,"readOnly":true}}},"domain.configuration.rules.RuleData":{"type":"object","description":"A rule data contains the fields that must be validated against a rule","properties":{"adminAccount":{"allOf":[{"$ref":"#/components/schemas/nichandle.Nichandle"}],"description":"The admin contact data","nullable":true},"domain":{"allOf":[{"$ref":"#/components/schemas/domain.Data"}],"description":"The domain data","nullable":true},"extras":{"allOf":[{"$ref":"#/components/schemas/domain.configuration.rules.RuleExtraData"}],"description":"The extra data of the rule","nullable":true},"owner":{"allOf":[{"$ref":"#/components/schemas/domain.Contact"}],"description":"The owner contact data","nullable":true},"techAccount":{"allOf":[{"$ref":"#/components/schemas/nichandle.Nichandle"}],"description":"The tech contact data","nullable":true}}},"domain.configuration.rules.RuleExtraData":{"type":"object","description":"The extra data contain additional rule data fields","properties":{"acceptCondition":{"type":"boolean","description":"Whether you accept the domain specific conditions or not","nullable":true},"authInfo":{"type":"string","description":"The auth info code for the domain","nullable":true,"format":"password"}}},"domain.configuration.rules.TypeEnum":{"type":"string","description":"Type of rule configuration","enum":["bool","contact","date_ISO8601","domain","json","number","string","string[]","text"]},"domain.data.claimNotice.Address":{"type":"object","description":"Address for a claim notice holder","properties":{"city":{"type":"string","description":"City","nullable":true,"readOnly":true},"countryCode":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Country code","nullable":true,"readOnly":true},"fax":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Fax number","nullable":true,"readOnly":true},"faxExtension":{"type":"string","description":"Fax number extension","nullable":true,"readOnly":true},"postalCode":{"type":"string","description":"Postal zip code","nullable":true,"readOnly":true},"stateOrProvince":{"type":"string","description":"State of province","nullable":true,"readOnly":true},"streets":{"type":"array","description":"Array of street name","items":{"type":"string"},"readOnly":true},"voice":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Phone number","nullable":true,"readOnly":true},"voiceExtension":{"type":"string","description":"Phone number extension","nullable":true,"readOnly":true}}},"domain.data.claimNotice.ClaimNotice":{"type":"object","description":"Definition of claim notices applying to a domain name","properties":{"claims":{"type":"array","description":"Array of claim notice for the domain","nullable":true,"items":{"$ref":"#/components/schemas/domain.data.claimNotice.ClaimNoticeDecision"},"readOnly":true},"endingDate":{"type":"string","description":"Ending date of claim notice","readOnly":true},"id":{"type":"string","description":"Claim notice ID","readOnly":true},"label":{"type":"string","description":"Label referring to claim notice","readOnly":true},"startingDate":{"type":"string","description":"Beginning date of claim notice","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/domain.data.claimNotice.ClaimNoticeTypeEnum"}],"description":"Type of claim notice","nullable":true,"readOnly":true}}},"domain.data.claimNotice.ClaimNoticeDecision":{"type":"object","description":"Definition of a single claim notice","properties":{"classifications":{"type":"array","description":"Classifications where trademark claim notice apply","items":{"$ref":"#/components/schemas/domain.data.claimNotice.Classification"},"readOnly":true},"courtDecisions":{"type":"array","description":"Array of court decisions related to claim notice","items":{"$ref":"#/components/schemas/domain.data.claimNotice.CourtDecision"},"readOnly":true},"goodsAndServices":{"type":"string","description":"Goods and services on which apply claim notice","readOnly":true},"jurisdiction":{"type":"string","description":"Name of jurisdiction","readOnly":true},"jurisdictionCountryCode":{"type":"string","description":"Jurisdiction country code","readOnly":true},"markName":{"type":"string","description":"Mark name implicated in claim notice","readOnly":true},"trademarkContacts":{"type":"array","description":"Trademark contacts","items":{"$ref":"#/components/schemas/domain.data.claimNotice.Contact"},"readOnly":true},"trademarkHolders":{"type":"array","description":"Trademark holders","items":{"$ref":"#/components/schemas/domain.data.claimNotice.Contact"},"readOnly":true},"trademarkUDRP":{"type":"array","description":"Trademark UDRP information","items":{"$ref":"#/components/schemas/domain.data.claimNotice.UDRP"},"readOnly":true}}},"domain.data.claimNotice.ClaimNoticeTypeEnum":{"type":"string","description":"Type of claim notice","enum":["TRADEMARK","UK"]},"domain.data.claimNotice.Classification":{"type":"object","description":"Definition of a trademark claim notice classification","properties":{"description":{"type":"string","description":"Summary of the classification","readOnly":true},"number":{"type":"string","description":"Code of the classification","readOnly":true}}},"domain.data.claimNotice.Contact":{"type":"object","description":"Contact definition of a claim notice holder","properties":{"address":{"allOf":[{"$ref":"#/components/schemas/domain.data.claimNotice.Address"}],"description":"Address of holder","readOnly":true},"email":{"type":"string","description":"Email address","nullable":true,"readOnly":true},"entitlement":{"type":"string","description":"Legitimacy of holder","nullable":true,"readOnly":true},"name":{"type":"string","description":"Name of claim notice holder","nullable":true,"readOnly":true},"organisation":{"type":"string","description":"Organisation name","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of contact","nullable":true,"readOnly":true}}},"domain.data.claimNotice.CourtDecision":{"type":"object","description":"Definition of a court decision","properties":{"countryCode":{"type":"string","description":"Country code","readOnly":true},"courtName":{"type":"string","description":"Court name","readOnly":true},"referenceNumber":{"type":"string","description":"Reference number of court decision","readOnly":true},"regions":{"type":"array","description":"Regions where court decision apply","items":{"type":"string"},"readOnly":true}}},"domain.data.claimNotice.UDRP":{"type":"object","description":"Definition of a UDRP procedure","properties":{"caseNumber":{"type":"string","description":"Case number","readOnly":true},"udrpProvider":{"type":"string","description":"UDRP Provider","readOnly":true}}},"domain.data.smd.Smd":{"type":"object","description":"Representation of a SMD file","properties":{"data":{"type":"string","description":"SMD file content","readOnly":true},"id":{"type":"string","description":"UUID of SMD file","format":"uuid","readOnly":true},"notAfter":{"type":"string","description":"Date when information about SMD file aren't valid anymore","format":"date-time","readOnly":true},"notBefore":{"type":"string","description":"Date before when information about SMD file aren't valid yet","format":"date-time","readOnly":true},"protectedLabels":{"type":"array","description":"List of the labels that are protect with that SMD file","items":{"$ref":"#/components/schemas/domain.data.smd.SmdLabel"},"readOnly":true},"smdId":{"type":"string","description":"TMCH Internal identifier","readOnly":true}}},"domain.data.smd.SmdBody":{"type":"object","description":"Representation of a SMD file","properties":{"data":{"type":"string","description":"SMD file content in base64"}},"required":["data"]},"domain.data.smd.SmdLabel":{"type":"object","description":"Representation of a protected label","properties":{"label":{"type":"string","description":"Label that is protected","readOnly":true},"trademark":{"type":"string","description":"Trademark associated to the protected label","readOnly":true}}},"domain.extensions.CategoryNameWithExtensions":{"type":"object","description":"Result of extensions by category request","properties":{"extensions":{"type":"array","description":"List of extensions","items":{"type":"string"},"readOnly":true},"name":{"type":"string","description":"Name of the category","readOnly":true}}},"domain.extensions.CategoryTypeEnum":{"type":"string","description":"Type of extension category","enum":["geolocalization","thematic"]},"domain.extensions.Extension":{"type":"object","description":"A domain name extension","properties":{"name":{"type":"string","description":"The extension name","readOnly":true}}},"domain.extensions.ExtensionsByCategory":{"type":"object","description":"Result of extensions by category request","properties":{"geolocalization":{"type":"array","description":"Geolocalizations groups extensions by geographical place, like 'europe'","nullable":true,"items":{"$ref":"#/components/schemas/domain.extensions.CategoryNameWithExtensions"},"readOnly":true},"thematic":{"type":"array","description":"Thematics groups extensions by a thematic like 'gastronomy' for '.pizza'","nullable":true,"items":{"$ref":"#/components/schemas/domain.extensions.CategoryNameWithExtensions"},"readOnly":true}}},"domain.extensions.ExtensionsPricingAttributes":{"type":"object","description":"Result of getting pricing attributes of an extension","properties":{"brandNew":{"type":"boolean","description":"Parameter is true when the extension has been created recently and we want to highlight this fact","readOnly":true},"name":{"type":"string","description":"Extension name, like 'com' or 'co.uk'","readOnly":true},"priceDrop":{"type":"boolean","description":"Parameter is true when the extension price has dropped recently and we want to highlight this fact","readOnly":true}}},"domain.extensions.OrderByTypeEnum":{"type":"string","description":"Type used to change the order of extensions results","enum":["alphabetical","trending"]},"domain.extensions.registryConfigurations.CreateLifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations applied when creating a domain name","properties":{"allowedPeriodsInMonths":{"type":"array","description":"The number of months allowed for a domain creation","nullable":true,"items":{"type":"integer"},"readOnly":true}}},"domain.extensions.registryConfigurations.DNSRegistryConfiguration":{"type":"object","description":"The registry configurations applied to the DNS of a domain name","properties":{"isDNSSECSupported":{"type":"boolean","description":"Whether DNSSEC is supported by the registry/backend and handled by OVHcloud","readOnly":true},"maxNumber":{"type":"integer","description":"The maximum required number of DNS","nullable":true,"readOnly":true},"minNumber":{"type":"integer","description":"The minimum required number of DNS","nullable":true,"readOnly":true}}},"domain.extensions.registryConfigurations.DomainRegistryConfiguration":{"type":"object","description":"The registry configurations applied to a domain name","properties":{"extension_type":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.ExtensionTypeEnum"}],"description":"The type of an extension (cctld or gtld)","readOnly":true},"isAuthInfoSupported":{"type":"boolean","description":"Whether the registry uses an authInfo for this extension, whatever it is used for. This does not mean an incoming transfer is driven by an authInfo: some registries manage an authInfo to take control of a contact while their transfer process does not rely on one. See lifecycle.transfer.isAuthInfoRequired for the transfer requirement","readOnly":true},"isPremiumSupported":{"type":"boolean","description":"Whether premium domains are supported by the registry and handled by OVHcloud","readOnly":true},"label":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.LabelDomainRegistryConfiguration"}],"description":"The registry configurations applied to the domain name label","readOnly":true}}},"domain.extensions.registryConfigurations.ExtensionTypeEnum":{"type":"string","description":"The type of an extension (country-code TLD or generic TLD)","enum":["cctld","gtld"]},"domain.extensions.registryConfigurations.LabelDomainRegistryConfiguration":{"type":"object","description":"The registry configurations applied to the domain name label","properties":{"isIDNSupported":{"type":"boolean","description":"Whether International Domain Names are supported by the registry and handled by OVHcloud","readOnly":true},"maxLength":{"type":"integer","description":"The maximum length allowed for a domain name (without the extension)","nullable":true,"readOnly":true},"minLength":{"type":"integer","description":"The minimum length allowed for a domain name (without the extension)","nullable":true,"readOnly":true}}},"domain.extensions.registryConfigurations.LifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations of the lifecycle of a domain name","properties":{"create":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.CreateLifecycleRegistryConfiguration"}],"description":"The registry configurations applied when creating a domain name","readOnly":true},"order":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.OrderLifecycleRegistryConfiguration"}],"description":"The registry configurations applied when ordering a domain name","readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.RenewLifecycleRegistryConfiguration"}],"description":"The registry configurations applied when renewing a domain name","readOnly":true},"restore":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.RestoreLifecycleRegistryConfiguration"}],"description":"The registry configurations applied when restoring a domain name","readOnly":true},"transfer":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.TransferLifecycleRegistryConfiguration"}],"description":"The registry configurations applied when transfering a domain name","readOnly":true}}},"domain.extensions.registryConfigurations.OrderLifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations applied when ordering a domain name","properties":{"active":{"type":"boolean","description":"True if the extension can be ordered from the website","readOnly":true},"maxMonths":{"type":"integer","description":"The maximum number of months a domain can be ordered for","nullable":true,"readOnly":true},"minMonths":{"type":"integer","description":"The minimum number of months a domain can be ordered for","nullable":true,"readOnly":true}}},"domain.extensions.registryConfigurations.RegistryConfigurations":{"type":"object","description":"The registry configurations applied to a domain extension (TLD, SLD)","properties":{"dns":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.DNSRegistryConfiguration"}],"description":"Configurations on the DNS associated to the domain for the given extension","readOnly":true},"domain":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.DomainRegistryConfiguration"}],"description":"Configurations on the domain name itself for the given extension","readOnly":true},"lifecycle":{"allOf":[{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.LifecycleRegistryConfiguration"}],"description":"Configurations on the lifecycle of a domain for the given extension","readOnly":true}}},"domain.extensions.registryConfigurations.RenewLifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations applied when renewing a domain name","properties":{"allowedPeriodsInMonths":{"type":"array","description":"The number of months allowed for a domain renewal","nullable":true,"items":{"type":"integer"},"readOnly":true},"gracePeriodInDays":{"type":"integer","description":"The number of calendar days between the expiration date and the redemption period when a renew can be executed. During this period, the domain has expired and is suspended. It's the number of days before real deletion. The customer can still renew.","nullable":true,"readOnly":true}}},"domain.extensions.registryConfigurations.RestoreLifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations applied when restoring a domain name","properties":{"gracePeriodInDays":{"type":"integer","description":"The number of calendar days in which the customer still can restore their domain after expiration. During this period, the domain has been deleted. The customer can still restore it until these days are over. Then the domain is returned to public, if not restored.","nullable":true,"readOnly":true}}},"domain.extensions.registryConfigurations.TransferLifecycleRegistryConfiguration":{"type":"object","description":"The registry configurations applied when transfering a domain name","properties":{"allowedPeriodsInMonths":{"type":"array","description":"The number of months allowed for a domain transfer","nullable":true,"items":{"type":"integer"},"readOnly":true},"includeRenew":{"type":"boolean","description":"Whether the transfer includes a renewal of the domain name, and therefore updates its expiration date","readOnly":true},"incomingTransferDelayMaxDays":{"type":"integer","description":"The maximum estimated number of days for an incoming domain transfer","nullable":true,"readOnly":true},"incomingTransferDelayMinDays":{"type":"integer","description":"The minimum estimated number of days for an incoming domain transfer","nullable":true,"readOnly":true},"isAuthInfoRequired":{"type":"boolean","description":"Whether an authInfo has to be provided to request an incoming transfer on this extension. Independent from domain.isAuthInfoSupported: an extension can have an authInfo managed at the registry, to take control of a contact for instance, while its transfer process does not use one at all","readOnly":true},"transferBlockDelayInDays":{"type":"integer","description":"The minimum number of days after domain creation or last transfer before a new outgoing transfer is allowed. The ICANN default is 60 days, but this value can be overridden per registry. Null means no restriction applies.","nullable":true,"readOnly":true}}},"domain.order.ContactOwner":{"type":"object","description":"Owner contact reference for a domain order: an OVH contact resource, not a NIC handle.","properties":{"id":{"type":"integer","description":"Numeric identifier of the OVH contact resource (e.g. obtained from /me/contact). Distinct from a NIC handle such as xxxxx-ovh.","nullable":true}}},"domain.order.Contacts":{"type":"object","description":"Admin, tech and owner contacts for a domain order. admin and tech are OVH NIC handles (e.g. xxxxx-ovh); owner is an OVH contact resource referenced by its numeric id (see /me/contact), not a NIC handle. Billing is forced to the customer code by the server and is not exposed.","properties":{"admin":{"type":"string","description":"Administrative contact, given as an OVH NIC handle (e.g. xxxxx-ovh). Defaults to the calling customer's NIC if omitted.","nullable":true},"owner":{"allOf":[{"$ref":"#/components/schemas/domain.order.ContactOwner"}],"description":"Owner contact of the domain. Unlike admin/tech which are NIC handles, the owner is an OVH contact resource referenced by its numeric id.","nullable":true},"tech":{"type":"string","description":"Technical contact, given as an OVH NIC handle (e.g. xxxxx-ovh). Defaults to the admin contact if omitted.","nullable":true}}},"domain.order.Contract":{"type":"object","description":"A contract (terms) the customer subscribes to when placing a domain order","properties":{"name":{"type":"string","description":"Name of the contract (e.g. registration terms, general conditions of service)","readOnly":true},"url":{"type":"string","description":"URL to the contract terms document (PDF)","readOnly":true}}},"domain.order.OrderRequest":{"type":"object","description":"Payload to order a new domain name","properties":{"contacts":{"allOf":[{"$ref":"#/components/schemas/domain.order.Contacts"}],"description":"Admin, tech and owner contacts","nullable":true},"dns":{"type":"array","description":"List of DNS servers (hostnames) to set on the domain. Optional: if omitted, OVHcloud's recommended DNS servers for the domain are used.","nullable":true,"items":{"type":"string"}},"domain":{"type":"string","description":"Fully-qualified domain name to order, including the extension (e.g. example.com)"},"duration":{"type":"string","description":"Order duration in ISO-8601 format, whole years only (e.g. P1Y). Allowed values depend on the extension's registry configuration; an unsupported duration is rejected. Defaults to P1Y if omitted.","nullable":true,"format":"duration"},"priceAcknowledge":{"allOf":[{"$ref":"#/components/schemas/domain.order.PriceAcknowledge"}],"description":"Price the customer acknowledged before placing the order. Required for aftermarket or premium domains, optional otherwise. Its value/currency must equal the retail price quoted for this domain (e.g. via a dryRun order); a mismatch rejects the order.","nullable":true},"promoCodes":{"type":"array","description":"Promotion codes to apply. Optional.","nullable":true,"items":{"type":"string"}},"waiveRetractationPeriod":{"type":"boolean","description":"Acknowledgment that the customer waives the legal retractation period. Must be set to true to place the order.","nullable":true},"zone":{"allOf":[{"$ref":"#/components/schemas/domain.order.ZoneOptions"}],"description":"DNS zone options","nullable":true}},"required":["domain"]},"domain.order.OrderResponse":{"type":"object","description":"Response returned after placing a domain order","properties":{"contacts":{"allOf":[{"$ref":"#/components/schemas/domain.order.Contacts"}],"description":"Contacts attached to the order","nullable":true,"readOnly":true},"contracts":{"type":"array","description":"Legal contracts (terms, as PDFs) the customer subscribes to with this order","nullable":true,"items":{"$ref":"#/components/schemas/domain.order.Contract"},"readOnly":true},"dns":{"type":"array","description":"DNS servers set on the domain","nullable":true,"items":{"type":"string"},"readOnly":true},"domain":{"type":"string","description":"Ordered domain name","readOnly":true},"duration":{"type":"string","description":"Order duration in ISO-8601 format, whole years only (e.g. P1Y)","format":"duration","readOnly":true},"orderId":{"type":"integer","description":"Identifier of the created order, used with url to finalize and pay it","nullable":true,"readOnly":true},"pricing":{"allOf":[{"$ref":"#/components/schemas/domain.order.Pricing"}],"description":"Pricing breakdown of the order","readOnly":true},"url":{"type":"string","description":"Payment/finalization URL where the customer completes and pays the order","nullable":true,"readOnly":true},"zone":{"allOf":[{"$ref":"#/components/schemas/domain.order.ZoneOptions"}],"description":"DNS zone options applied to the order","nullable":true,"readOnly":true}}},"domain.order.Price":{"type":"object","description":"Price with its currency and textual representation as returned by domain/order","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/order.CurrencyCodeEnum"}],"description":"Currency code","readOnly":true},"text":{"type":"string","description":"Human-readable price with currency, e.g. \"6.08 EUR\"","readOnly":true},"value":{"type":"number","description":"The effective price as a number, e.g. 6.08","readOnly":true}}},"domain.order.PriceAcknowledge":{"type":"object","description":"Minimal price payload sent by the client to acknowledge the price seen, before placing the actual order","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/order.CurrencyCodeEnum"}],"description":"Currency code of the acknowledged price"},"value":{"type":"number","description":"The effective price acknowledged by the client"}},"required":["currencyCode","value"]},"domain.order.Pricing":{"type":"object","description":"Pricing breakdown with and without tax","properties":{"basePriceWithoutTax":{"allOf":[{"$ref":"#/components/schemas/domain.order.Price"}],"description":"Price excluding tax before any promotion","readOnly":true},"discount":{"allOf":[{"$ref":"#/components/schemas/domain.order.Price"}],"description":"Total reduction applied by promotions, as a positive amount (0 if none)","readOnly":true},"finalPriceWithTax":{"allOf":[{"$ref":"#/components/schemas/domain.order.Price"}],"description":"Final price including tax, after any reduction","readOnly":true},"finalPriceWithoutTax":{"allOf":[{"$ref":"#/components/schemas/domain.order.Price"}],"description":"Final price excluding tax, after any reduction","readOnly":true},"tax":{"allOf":[{"$ref":"#/components/schemas/domain.order.Price"}],"description":"Tax amount on the final price","readOnly":true}}},"domain.order.ZoneOptions":{"type":"object","description":"DNS zone options for a domain order","properties":{"anycast":{"type":"boolean","description":"Enable Anycast on the DNS zone. Applied only when a new zone is created (create=true and no existing zone); ignored otherwise.","nullable":true},"create":{"type":"boolean","description":"Whether to create the DNS zone along with the domain. Defaults to true if omitted.","nullable":true},"dnssec":{"type":"boolean","description":"Enable DNSSEC on the DNS zone. Applied only when a new zone is created (create=true and no existing zone); defaults to true in that case when omitted.","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"},"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"},"nichandle.CountryEnum":{"type":"string","description":"Countries a nichandle can choose","enum":["AC","AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","UNKNOWN","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"nichandle.Currency":{"type":"object","description":"Customer currency","properties":{"code":{"type":"string","description":"Currency code"},"symbol":{"type":"string","description":"Currency symbol"}}},"nichandle.GenderEnum":{"type":"string","description":"All genders a person can choose","enum":["female","male"]},"nichandle.LanguageEnum":{"type":"string","description":"Languages a nichandle can choose","enum":["cs_CZ","de_DE","en_AU","en_CA","en_GB","en_IE","en_US","es_ES","fi_FI","fr_CA","fr_FR","fr_MA","fr_SN","fr_TN","it_IT","lt_LT","nl_NL","pl_PL","pt_PT"]},"nichandle.LegalFormEnum":{"type":"string","description":"Legal forms a nichandle can be registered as","enum":["administration","association","corporation","individual","other","personalcorporation"]},"nichandle.Nichandle":{"type":"object","description":"Details about your OVH identifier","properties":{"address":{"type":"string","description":"Address of nichandle","nullable":true},"area":{"type":"string","description":"Area of nichandle","nullable":true},"birthCity":{"type":"string","description":"City of birth","nullable":true},"birthDay":{"type":"string","description":"Birth date","nullable":true},"city":{"type":"string","description":"City of nichandle","nullable":true},"companyNationalIdentificationNumber":{"type":"string","description":"Company National Identification Number","nullable":true},"complementaryAddress":{"type":"string","description":"Complementary Address","nullable":true},"corporationType":{"type":"string","description":"Corporation type","nullable":true},"country":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"Customer country"},"currency":{"allOf":[{"$ref":"#/components/schemas/nichandle.Currency"}],"description":"Customer currency","readOnly":true},"customerCode":{"type":"string","description":"Your customer code (a numerical value used for identification when contacting support via phone call)","nullable":true,"readOnly":true},"displayName":{"type":"string","description":"Display name shown instead of the organisation name.","nullable":true},"einvoicingBillingAddress":{"type":"string","description":"Default e-invoicing billing address","nullable":true},"email":{"type":"string","description":"Email address","readOnly":true},"fax":{"type":"string","description":"Fax number","nullable":true},"firstname":{"type":"string","description":"First name","nullable":true},"italianSDI":{"type":"string","description":"Italian SDI","nullable":true},"kycValidated":{"type":"boolean","description":"KYC validation state","nullable":true,"readOnly":true},"language":{"allOf":[{"$ref":"#/components/schemas/nichandle.LanguageEnum"}],"description":"Language","nullable":true},"legalform":{"allOf":[{"$ref":"#/components/schemas/nichandle.LegalFormEnum"}],"description":"Customer legal form"},"name":{"type":"string","description":"Customer name","nullable":true},"nationalIdentificationNumber":{"type":"string","description":"National Identification Number","nullable":true},"nichandle":{"type":"string","description":"Customer identifier","readOnly":true},"organisation":{"type":"string","description":"Name of organisation","nullable":true},"ovhCompany":{"allOf":[{"$ref":"#/components/schemas/nichandle.OvhCompanyEnum"}],"description":"OVH company","readOnly":true},"ovhSubsidiary":{"allOf":[{"$ref":"#/components/schemas/nichandle.OvhSubsidiaryEnum"}],"description":"OVH subsidiary","readOnly":true},"phone":{"type":"string","description":"Phone number","nullable":true},"phoneCountry":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"nullable":true},"phoneType":{"allOf":[{"$ref":"#/components/schemas/nichandle.PhoneTypeEnum"}],"description":"Type of phone(mobile, landline)","nullable":true},"purposeOfPurchase":{"type":"string","description":"Customer purpose of purchase","nullable":true},"sex":{"allOf":[{"$ref":"#/components/schemas/nichandle.GenderEnum"}],"description":"Gender","nullable":true},"spareEmail":{"type":"string","description":"Spare email","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/nichandle.StateEnum"}],"description":"Nichandle state","readOnly":true},"vat":{"type":"string","description":"VAT number","nullable":true},"zip":{"type":"string","description":"Zipcode","nullable":true}}},"nichandle.OvhCompanyEnum":{"type":"string","description":"OVH companies","enum":["kimsufi","ovh","soyoustart"]},"nichandle.OvhSubsidiaryEnum":{"type":"string","description":"OVH subsidiaries","enum":["CZ","DE","ES","EU","FI","FR","GB","IE","IT","LT","MA","NL","PL","PT","SN","TN"]},"nichandle.PhoneTypeEnum":{"type":"string","description":"All phone type a person can choose","enum":["landline","mobile"]},"nichandle.StateEnum":{"type":"string","description":"States a nichandle can be in","enum":["complete","incomplete"]},"order.CurrencyCodeEnum":{"type":"string","description":"Currency code","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"]},"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/configurationRule":{"get":{"summary":"Get configuration rule applied for a domain in a given action","parameters":[{"in":"query","name":"action","description":"Depending on the action, the applied rule will change (transfer vs create)","required":true,"schema":{"$ref":"#/components/schemas/domain.ActionEnum"}},{"in":"query","name":"domain","description":"The domain to get the configuration rule for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.configuration.rules.Rule"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@70"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/configurationRule\")\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(\"/domain/configurationRule\");\n\nprint_r($result);\n?>"}]}},"/domain/configurationRule/check":{"post":{"summary":"Validate a rule data for a specified domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"action","description":"Depending on the action, the applied rule will change (transfer vs create)","required":true,"schema":{"$ref":"#/components/schemas/domain.ActionEnum"}},{"in":"query","name":"domain","description":"The domain to check the rule data for","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.configuration.rules.RuleData"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@80"]],"x-badges":[{"color":"green","label":"Stable production 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.configuration.rules.RuleData\nresult = client.post(\"/domain/configurationRule/check\",\n\tadminAccount = None, # The admin contact data (type: nichandle.Nichandle, nullable)\n\tdomain = None, # The domain data (type: domain.Data, nullable)\n\textras = None, # The extra data of the rule (type: domain.configuration.rules.RuleExtraData, nullable)\n\towner = None, # The owner contact data (type: domain.Contact, nullable)\n\ttechAccount = None, # The tech contact data (type: nichandle.Nichandle, 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: domain.configuration.rules.RuleData\n$result = $ovh->post(\"/domain/configurationRule/check\", array(\n\tadminAccount => null, // The admin contact data (type: nichandle.Nichandle, nullable)\n\tdomain => null, // The domain data (type: domain.Data, nullable)\n\textras => null, // The extra data of the rule (type: domain.configuration.rules.RuleExtraData, nullable)\n\towner => null, // The owner contact data (type: domain.Contact, nullable)\n\ttechAccount => null, // The tech contact data (type: nichandle.Nichandle, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/configurationRule/check","required":true}]}},"/domain/data/claimNotice":{"get":{"summary":"Retrieve claim notices associated to a domain","parameters":[{"in":"query","name":"domain","description":"Domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.claimNotice.ClaimNotice"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@90"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/data/claimNotice\")\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(\"/domain/data/claimNotice\");\n\nprint_r($result);\n?>"}]}},"/domain/data/smd":{"get":{"summary":"List all SMD files","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.data.smd.Smd"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@100"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/data/smd\")\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(\"/domain/data/smd\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/data/smd/get","required":true}],"x-response-identifier":"id","x-expanded-response":"DomainDataSmdSmd"},"post":{"summary":"Create a SMD file","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.smd.SmdBody"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.smd.Smd"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@120"]],"x-badges":[{"color":"green","label":"Stable production 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.data.smd.SmdBody\nresult = client.post(\"/domain/data/smd\",\n\tdata = None, # SMD file content in base64 (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: domain.data.smd.SmdBody\n$result = $ovh->post(\"/domain/data/smd\", array(\n\tdata => null, // SMD file content in base64 (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/data/smd/create","required":true}]}},"/domain/data/smd/{smdId}":{"delete":{"summary":"Delete a SMD file","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"smdId","description":"Smd ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@130"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/data/smd/{smdId}\")\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(\"/domain/data/smd/{smdId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/data/smd/delete","required":true}]},"get":{"summary":"Get details about a SMD file","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"smdId","description":"Smd ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.smd.Smd"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@110"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/data/smd/{smdId}\")\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(\"/domain/data/smd/{smdId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/data/smd/get","required":true}],"x-response-identifier":"id"},"put":{"summary":"Update a SMD file","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"smdId","description":"Smd ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.smd.SmdBody"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.data.smd.Smd"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@140"]],"x-badges":[{"color":"green","label":"Stable production 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.data.smd.SmdBody\nresult = client.put(\"/domain/data/smd/{smdId}\",\n\tdata = None, # SMD file content in base64 (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: domain.data.smd.SmdBody\n$result = $ovh->put(\"/domain/data/smd/{smdId}\", array(\n\tdata => null, // SMD file content in base64 (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/data/smd/edit","required":true}]}},"/domain/extensions":{"get":{"summary":"List all extensions","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"geolocalizations","description":"Filter only extensions related to this list of geolocalization places (comma separated). Default to empty.","schema":{"type":"string"}},{"in":"query","name":"orderBy","description":"Order results by name (alphabetical) or trending importance (trending). Default to alphabetical.","schema":{"$ref":"#/components/schemas/domain.extensions.OrderByTypeEnum"}},{"in":"query","name":"ovhSubsidiary","description":"OVHcloud subsidiary targeted. Useful only when orderBy is equal to trending. Default to FR.","schema":{"$ref":"#/components/schemas/nichandle.OvhSubsidiaryEnum"}},{"in":"query","name":"thematics","description":"Filter only extensions related to this list of thematics (comma separated). Default to empty.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@10"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions\")\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(\"/domain/extensions\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/get","required":true}],"x-expanded-response":"DomainExtensionsExtension"}},"/domain/extensions/byCategory":{"get":{"summary":"List extensions, grouped by category types (like 'thematic', 'geolocalization') and category names (like 'europe')","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"categoryType","description":"Filter by category types","schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.extensions.CategoryTypeEnum"}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.extensions.ExtensionsByCategory"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@30"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions/byCategory\")\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(\"/domain/extensions/byCategory\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/byCategory/get","required":true}]}},"/domain/extensions/highlighted":{"get":{"summary":"List highlighted extensions, ordered by decreased importance","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"ovhSubsidiary","description":"OVHcloud subsidiary targeted. Highlighted extensions are different from one subsidiary to another. Default to FR.","schema":{"$ref":"#/components/schemas/nichandle.OvhSubsidiaryEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@40"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions/highlighted\")\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(\"/domain/extensions/highlighted\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/highlighted/get","required":true}]}},"/domain/extensions/pricingAttributes":{"get":{"summary":"List extensions with their pricing attributes","description":"List extensions with their pricing attributes. It especially documents whether an extension has been implemented recently or whether the price has dropped.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"ovhSubsidiary","description":"OVHcloud subsidiary targeted. Attributes may be different from one subsidiary to another. Default to FR.","schema":{"$ref":"#/components/schemas/nichandle.OvhSubsidiaryEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.extensions.ExtensionsPricingAttributes"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@50"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions/pricingAttributes\")\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(\"/domain/extensions/pricingAttributes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/get","required":true}]}},"/domain/extensions/{name}":{"get":{"summary":"Get an extension","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.extensions.Extension"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@20"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions/{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(\"/domain/extensions/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/get","required":true}],"x-response-identifier":"name"}},"/domain/extensions/{name}/registryConfigurations":{"get":{"summary":"Retrieve registry configuration for an extension","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.extensions.registryConfigurations.RegistryConfigurations"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@60"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/domain/extensions/{name}/registryConfigurations\")\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(\"/domain/extensions/{name}/registryConfigurations\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/extension/registryConfiguration/get","required":true}]}},"/domain/order/create":{"post":{"summary":"Order a new domain name","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"dryRun","description":"If true, simulate the order and return the pricing without actually placing it. Default to false.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.order.OrderRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.order.OrderResponse"}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Extensions & ordering@@@150"]],"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.order.OrderRequest\nresult = client.post(\"/domain/order/create\",\n\tcontacts = None, # Admin, tech and owner contacts (type: domain.order.Contacts, nullable)\n\tdns = None, # List of DNS servers (hostnames) to set on the domain. Optional: if omitted, OVHcloud's recommended DNS servers for the domain are used. (type: array, nullable)\n\tdomain = None, # Fully-qualified domain name to order, including the extension (e.g. example.com) (type: string)\n\tduration = None, # Order duration in ISO-8601 format, whole years only (e.g. P1Y). Allowed values depend on the extension's registry configuration; an unsupported duration is rejected. Defaults to P1Y if omitted. (type: string, nullable)\n\tpriceAcknowledge = None, # Price the customer acknowledged before placing the order. Required for aftermarket or premium domains, optional otherwise. Its value/currency must equal the retail price quoted for this domain (e.g. via a dryRun order); a mismatch rejects the order. (type: domain.order.PriceAcknowledge, nullable)\n\tpromoCodes = None, # Promotion codes to apply. Optional. (type: array, nullable)\n\twaiveRetractationPeriod = None, # Acknowledgment that the customer waives the legal retractation period. Must be set to true to place the order. (type: boolean, nullable)\n\tzone = None, # DNS zone options (type: domain.order.ZoneOptions, 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: domain.order.OrderRequest\n$result = $ovh->post(\"/domain/order/create\", array(\n\tcontacts => null, // Admin, tech and owner contacts (type: domain.order.Contacts, nullable)\n\tdns => null, // List of DNS servers (hostnames) to set on the domain. Optional: if omitted, OVHcloud's recommended DNS servers for the domain are used. (type: array, nullable)\n\tdomain => null, // Fully-qualified domain name to order, including the extension (e.g. example.com) (type: string)\n\tduration => null, // Order duration in ISO-8601 format, whole years only (e.g. P1Y). Allowed values depend on the extension's registry configuration; an unsupported duration is rejected. Defaults to P1Y if omitted. (type: string, nullable)\n\tpriceAcknowledge => null, // Price the customer acknowledged before placing the order. Required for aftermarket or premium domains, optional otherwise. Its value/currency must equal the retail price quoted for this domain (e.g. via a dryRun order); a mismatch rejects the order. (type: domain.order.PriceAcknowledge, nullable)\n\tpromoCodes => null, // Promotion codes to apply. Optional. (type: array, nullable)\n\twaiveRetractationPeriod => null, // Acknowledgment that the customer waives the legal retractation period. Must be set to true to place the order. (type: boolean, nullable)\n\tzone => null, // DNS zone options (type: domain.order.ZoneOptions, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:domain/order/create","required":true}]}}}}