Extensions & ordering
All operations require authentication, except the 2 marked Public.
List all extensionsProduction
Query parameters
Filter only extensions related to this list of geolocalization places (comma separated). Default to empty.
Order results by name (alphabetical) or trending importance (trending). Default to alphabetical.
alphabeticaltrendingOVHcloud subsidiary targeted. Useful only when orderBy is equal to trending. Default to FR.
CZDEESEUFIFRGBIEITLTMANLPLPTSNTNFilter only extensions related to this list of thematics (comma separated). Default to empty.
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
Get an extensionProduction
Path parameters
Name
Response
The extension name
Example uses name = string
$ curl https:/{ "name": "string"}
List extensions, grouped by category types (like 'thematic', 'geolocalization') and category names (like 'europe')Production
Query parameters
Filter by category types
geolocalizationthematicResponse
Geolocalizations groups extensions by geographical place, like 'europe'
Thematics groups extensions by a thematic like 'gastronomy' for '.pizza'
Reads your token from $OVH_TOKEN
$ curl https:/{ "geolocalization": [ { "extensions": [ "string" ], "name": "string" } ], "thematic": [ { "extensions": [ "string" ], "name": "string" } ]}
List highlighted extensions, ordered by decreased importanceProduction
Query parameters
OVHcloud subsidiary targeted. Highlighted extensions are different from one subsidiary to another. Default to FR.
CZDEESEUFIFRGBIEITLTMANLPLPTSNTNResponse
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
List extensions with their pricing attributesProduction
List extensions with their pricing attributes. It especially documents whether an extension has been implemented recently or whether the price has dropped.
Query parameters
OVHcloud subsidiary targeted. Attributes may be different from one subsidiary to another. Default to FR.
CZDEESEUFIFRGBIEITLTMANLPLPTSNTNResponse
Parameter is true when the extension has been created recently and we want to highlight this fact
Extension name, like 'com' or 'co.uk'
Parameter is true when the extension price has dropped recently and we want to highlight this fact
Reads your token from $OVH_TOKEN
$ curl https:/[ { "brandNew": true, "name": "string", "priceDrop": true }]
Retrieve registry configuration for an extensionProduction
Path parameters
Name
Response
Configurations on the DNS associated to the domain for the given extension
Configurations on the domain name itself for the given extension
Configurations on the lifecycle of a domain for the given extension
Example uses name = string
$ curl https:/{ "dns": { "isDNSSECSupported": true, "maxNumber": 0, "minNumber": 0 }, "domain": { "extension_type": "cctld", "isAuthInfoSupported": true, "isPremiumSupported": true, "label": { "isIDNSupported": true, "maxLength": 0, "minLength": 0 } }, "lifecycle": { "create": { "allowedPeriodsInMonths": [ 0 ] }, "order": { "active": true, "maxMonths": 0, "minMonths": 0 }, "renew": { "allowedPeriodsInMonths": [ 0 ], "gracePeriodInDays": 0 }, "restore": { "gracePeriodInDays": 0 }, "transfer": { "allowedPeriodsInMonths": [ 0 ], "includeRenew": true, "incomingTransferDelayMaxDays": 0, "incomingTransferDelayMinDays": 0, "isAuthInfoRequired": true, "transferBlockDelayInDays": 0 } }}
Get configuration rule applied for a domain in a given actionProductionPublic
Query parameters
Depending on the action, the applied rule will change (transfer vs create)
createtradetransferupdateThe domain to get the configuration rule for
Response
An "and" operator on multiple rules
Whether this rule is applied or not
The constraints of the rule
The context on which the rule applies
accept_conditionsclaimscreateorderpremiumprotected_codereasontradetransferupdateThe description of the rule
The fields with specific rules
The label of the rule
An "or" operator on multiple rules
The default value used for the rule
The type of the object the rule applies on
boolcontactdate_ISO8601domainjsonnumberstringstring[]textPublic: no token needed
$ curl https:/{ "and": [ {} ], "conditions": {}, "constraints": [ { "conditions": {}, "contexts": [ "accept_conditions" ], "operator": "between", "value": "string", "values": [ "string" ] } ], "contexts": [ "accept_conditions" ], "description": "string", "fields": {}, "label": "string", "or": [ {} ], "placeholder": "string", "type": "bool"}
Validate a rule data for a specified domainProduction
Query parameters
Depending on the action, the applied rule will change (transfer vs create)
createtradetransferupdateThe domain to check the rule data for
Request body (required)
The admin contact data
The domain data
The extra data of the rule
The owner contact data
The tech contact data
Response
Reads your token from $OVH_TOKEN
$ curl https:/Retrieve claim notices associated to a domainProductionPublic
Query parameters
Domain name
Response
Array of claim notice for the domain
Ending date of claim notice
Claim notice ID
Label referring to claim notice
Beginning date of claim notice
Type of claim notice
TRADEMARKUKPublic: no token needed
$ curl https:/{ "claims": [ { "classifications": [ { "description": "string", "number": "string" } ], "courtDecisions": [ { "countryCode": "string", "courtName": "string", "referenceNumber": "string", "regions": [ "string" ] } ], "goodsAndServices": "string", "jurisdiction": "string", "jurisdictionCountryCode": "string", "markName": "string", "trademarkContacts": [ { "address": { "city": "string", "countryCode": "AC", "fax": "string", "faxExtension": "string", "postalCode": "string", "stateOrProvince": "string", "streets": [ null ], "voice": "string", "voiceExtension": "string" }, "email": "string", "entitlement": "string", "name": "string", "organisation": "string", "type": "string" } ], "trademarkHolders": [ { "address": { "city": "string", "countryCode": "AC", "fax": "string", "faxExtension": "string", "postalCode": "string", "stateOrProvince": "string", "streets": [ null ], "voice": "string", "voiceExtension": "string" }, "email": "string", "entitlement": "string", "name": "string", "organisation": "string", "type": "string" } ], "trademarkUDRP": [ { "caseNumber": "string", "udrpProvider": "string" } ] } ], "endingDate": "string", "id": "string", "label": "string", "startingDate": "string", "type": "TRADEMARK"}
List all SMD filesProduction
Response
SMD file content
UUID of SMD file
Date when information about SMD file aren't valid anymore
Date before when information about SMD file aren't valid yet
List of the labels that are protect with that SMD file
TMCH Internal identifier
Reads your token from $OVH_TOKEN
$ curl https:/[ { "data": "string", "id": "00000000-0000-0000-0000-000000000000", "notAfter": "2024-01-01T12:00:00Z", "notBefore": "2024-01-01T12:00:00Z", "protectedLabels": [ { "label": "string", "trademark": "string" } ], "smdId": "string" }]
Get details about a SMD fileProduction
Path parameters
Smd ID
Response
SMD file content
UUID of SMD file
Date when information about SMD file aren't valid anymore
Date before when information about SMD file aren't valid yet
List of the labels that are protect with that SMD file
TMCH Internal identifier
Example uses smdId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "data": "string", "id": "00000000-0000-0000-0000-000000000000", "notAfter": "2024-01-01T12:00:00Z", "notBefore": "2024-01-01T12:00:00Z", "protectedLabels": [ { "label": "string", "trademark": "string" } ], "smdId": "string"}
Create a SMD fileProduction
Request body (required)
SMD file content in base64
Response
SMD file content
UUID of SMD file
Date when information about SMD file aren't valid anymore
Date before when information about SMD file aren't valid yet
List of the labels that are protect with that SMD file
TMCH Internal identifier
Reads your token from $OVH_TOKEN
$ curl https:/{ "data": "string", "id": "00000000-0000-0000-0000-000000000000", "notAfter": "2024-01-01T12:00:00Z", "notBefore": "2024-01-01T12:00:00Z", "protectedLabels": [ { "label": "string", "trademark": "string" } ], "smdId": "string"}
Delete a SMD fileProduction
Path parameters
Smd ID
Response
Example uses smdId = 00000000-0000-0000-0000-000000000000
$ curl https:/Update a SMD fileProduction
Path parameters
Smd ID
Request body (required)
SMD file content in base64
Response
SMD file content
UUID of SMD file
Date when information about SMD file aren't valid anymore
Date before when information about SMD file aren't valid yet
List of the labels that are protect with that SMD file
TMCH Internal identifier
Example uses smdId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "data": "string", "id": "00000000-0000-0000-0000-000000000000", "notAfter": "2024-01-01T12:00:00Z", "notBefore": "2024-01-01T12:00:00Z", "protectedLabels": [ { "label": "string", "trademark": "string" } ], "smdId": "string"}
Order a new domain nameBeta
Query parameters
If true, simulate the order and return the pricing without actually placing it. Default to false.
Request body (required)
Admin, tech and owner contacts
List of DNS servers (hostnames) to set on the domain. Optional: if omitted, OVHcloud's recommended DNS servers for the domain are used.
Fully-qualified domain name to order, including the extension (e.g. example.com)
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.
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.
Promotion codes to apply. Optional.
Acknowledgment that the customer waives the legal retractation period. Must be set to true to place the order.
DNS zone options
Response
Contacts attached to the order
Legal contracts (terms, as PDFs) the customer subscribes to with this order
DNS servers set on the domain
Ordered domain name
Order duration in ISO-8601 format, whole years only (e.g. P1Y)
Identifier of the created order, used with url to finalize and pay it
Pricing breakdown of the order
Payment/finalization URL where the customer completes and pays the order
DNS zone options applied to the order
Reads your token from $OVH_TOKEN
$ curl https:/{ "contacts": { "admin": "string", "owner": { "id": 0 }, "tech": "string" }, "contracts": [ { "name": "string", "url": "string" } ], "dns": [ "string" ], "domain": "string", "duration": "string", "orderId": 0, "pricing": { "basePriceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "discount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "finalPriceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "finalPriceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "tax": { "currencyCode": "AUD", "text": "string", "value": 0 } }, "url": "string", "zone": { "anycast": true, "create": true, "dnssec": true }}