{"apiVersion":"1.0","apis":[{"path":"/domain","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDomains","httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"},{"name":"whoisOwner","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter domain names by owner ID"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"Get the list of managed domain names","iamActions":[{"name":"domain:apiovh:get","required":true}]}],"description":""},{"path":"/domain/configurationRule","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"action","dataType":"domain.ActionEnum","paramType":"query","fullType":"domain.ActionEnum","required":true,"description":"Depending on the action, the applied rule will change (transfer vs create)"},{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"The domain to get the configuration rule for"}],"responseType":"domain.configuration.rules.Rule","responseTypes":{"200":"domain.configuration.rules.Rule"},"noAuthentication":true,"description":"Get configuration rule applied for a domain in a given action"}],"description":""},{"path":"/domain/configurationRule/check","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.configuration.rules.RuleData","paramType":"body","fullType":"domain.configuration.rules.RuleData","required":true,"description":"Request Body"},{"name":"action","dataType":"domain.ActionEnum","paramType":"query","fullType":"domain.ActionEnum","required":true,"description":"Depending on the action, the applied rule will change (transfer vs create)"},{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"The domain to check the rule data for"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Validate a rule data for a specified domain","iamActions":[{"name":"account:apiovh:domain/configurationRule/check","required":true}]}],"description":""},{"path":"/domain/contact","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getContacts","httpMethod":"GET","parameters":[],"responseType":"domain.Contact[]","responseTypes":{"200":"domain.Contact[]"},"noAuthentication":false,"description":"List all contacts","iamActions":[{"name":"account:apiovh:domain/contact/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createContact","httpMethod":"POST","parameters":[{"dataType":"domain.Contact","paramType":"body","fullType":"domain.Contact","required":true,"description":"Request Body"}],"responseType":"domain.Contact","responseTypes":{"200":"domain.Contact"},"noAuthentication":false,"description":"Create a contact","iamActions":[{"name":"account:apiovh:domain/contact/create","required":true}]}],"description":"Operations on contacts"},{"path":"/domain/contact/{contactId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getContact","httpMethod":"GET","parameters":[{"name":"contactId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Contact ID"}],"responseType":"domain.Contact","responseTypes":{"200":"domain.Contact"},"noAuthentication":false,"description":"Get details about a contact","iamActions":[{"name":"account:apiovh:domain/contact/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"updateContact","httpMethod":"PUT","parameters":[{"dataType":"domain.Contact","paramType":"body","fullType":"domain.Contact","required":true,"description":"Request Body"},{"name":"contactId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Contact ID"}],"responseType":"domain.Contact","responseTypes":{"200":"domain.Contact"},"noAuthentication":false,"description":"Update a contact","iamActions":[{"name":"account:apiovh:domain/contact/edit","required":true}]}],"description":"Operations on contacts"},{"path":"/domain/data/claimNotice","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Domain name"}],"responseType":"domain.data.claimNotice.ClaimNotice","responseTypes":{"200":"domain.data.claimNotice.ClaimNotice"},"noAuthentication":true,"description":"Retrieve claim notices associated to a domain"}],"description":"Retrieve claim notices"},{"path":"/domain/data/extension","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2021-08-31T00:00:00Z","deprecatedDate":"2021-02-01T00:00:00Z","replacement":"/domain/extensions"},"httpMethod":"GET","parameters":[{"name":"country","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":false,"description":"Ovh subsidiary targeted"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":true,"description":"List all the extensions for a specific country"}],"description":"List all the extensions for a specific country"},{"path":"/domain/data/smd","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[],"responseType":"domain.data.smd.Smd[]","responseTypes":{"200":"domain.data.smd.Smd[]"},"noAuthentication":false,"description":"List all SMD files","iamActions":[{"name":"account:apiovh:domain/data/smd/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.data.smd.SmdBody","paramType":"body","fullType":"domain.data.smd.SmdBody","required":true,"description":"Request Body"}],"responseType":"domain.data.smd.Smd","responseTypes":{"200":"domain.data.smd.Smd"},"noAuthentication":false,"description":"Create a SMD file","iamActions":[{"name":"account:apiovh:domain/data/smd/create","required":true}]}],"description":"Operations on Signed Marked Definition (SMD) files"},{"path":"/domain/data/smd/{smdId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"smdId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Smd ID"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a SMD file","iamActions":[{"name":"account:apiovh:domain/data/smd/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"smdId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Smd ID"}],"responseType":"domain.data.smd.Smd","responseTypes":{"200":"domain.data.smd.Smd"},"noAuthentication":false,"description":"Get details about a SMD file","iamActions":[{"name":"account:apiovh:domain/data/smd/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"domain.data.smd.SmdBody","paramType":"body","fullType":"domain.data.smd.SmdBody","required":true,"description":"Request Body"},{"name":"smdId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Smd ID"}],"responseType":"domain.data.smd.Smd","responseTypes":{"200":"domain.data.smd.Smd"},"noAuthentication":false,"description":"Update a SMD file","iamActions":[{"name":"account:apiovh:domain/data/smd/edit","required":true}]}],"description":"Operations on Signed Marked Definition (SMD) files"},{"path":"/domain/extensions","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"geolocalizations","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter only extensions related to this list of geolocalization places (comma separated). Default to empty."},{"name":"orderBy","dataType":"domain.extensions.OrderByTypeEnum","paramType":"query","fullType":"domain.extensions.OrderByTypeEnum","required":false,"description":"Order results by name (alphabetical) or trending importance (trending). Default to alphabetical."},{"name":"ovhSubsidiary","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":false,"description":"OVHcloud subsidiary targeted. Useful only when orderBy is equal to trending. Default to FR."},{"name":"thematics","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter only extensions related to this list of thematics (comma separated). Default to empty."}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List all extensions","iamActions":[{"name":"account:apiovh:domain/extension/get","required":true}]}],"description":"Operations on domain name extensions"},{"path":"/domain/extensions/byCategory","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"categoryType","dataType":"domain.extensions.CategoryTypeEnum[]","paramType":"query","fullType":"domain.extensions.CategoryTypeEnum[]","required":false,"description":"Filter by category types"}],"responseType":"domain.extensions.ExtensionsByCategory","responseTypes":{"200":"domain.extensions.ExtensionsByCategory"},"noAuthentication":false,"description":"List extensions, grouped by category types (like 'thematic', 'geolocalization') and category names (like 'europe')","iamActions":[{"name":"account:apiovh:domain/extension/byCategory/get","required":true}]}],"description":""},{"path":"/domain/extensions/highlighted","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"ovhSubsidiary","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":false,"description":"OVHcloud subsidiary targeted. Highlighted extensions are different from one subsidiary to another. Default to FR."}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List highlighted extensions, ordered by decreased importance","iamActions":[{"name":"account:apiovh:domain/extension/highlighted/get","required":true}]}],"description":""},{"path":"/domain/extensions/pricingAttributes","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"ovhSubsidiary","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":false,"description":"OVHcloud subsidiary targeted. Attributes may be different from one subsidiary to another. Default to FR."}],"responseType":"domain.extensions.ExtensionsPricingAttributes[]","responseTypes":{"200":"domain.extensions.ExtensionsPricingAttributes[]"},"noAuthentication":false,"description":"List extensions with their pricing attributes","longDescription":"List extensions with their pricing attributes. It especially documents whether an extension has been implemented recently or whether the price has dropped.","iamActions":[{"name":"account:apiovh:domain/extension/get","required":true}]}],"description":""},{"path":"/domain/extensions/{name}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name"}],"responseType":"domain.extensions.Extension","responseTypes":{"200":"domain.extensions.Extension"},"noAuthentication":false,"description":"Get an extension","iamActions":[{"name":"account:apiovh:domain/extension/get","required":true}]}],"description":"Operations on domain name extensions"},{"path":"/domain/extensions/{name}/registryConfigurations","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name"}],"responseType":"domain.extensions.registryConfigurations.RegistryConfigurations","responseTypes":{"200":"domain.extensions.registryConfigurations.RegistryConfigurations"},"noAuthentication":false,"description":"Retrieve registry configuration for an extension","iamActions":[{"name":"account:apiovh:domain/extension/registryConfiguration/get","required":true}]}],"description":"Retrieve registry configurations for an extension"},{"path":"/domain/order/create","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"POST","parameters":[{"dataType":"domain.order.OrderRequest","paramType":"body","fullType":"domain.order.OrderRequest","required":true,"description":"Request Body"},{"name":"dryRun","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"If true, simulate the order and return the pricing without actually placing it. Default to false."}],"responseType":"domain.order.OrderResponse","responseTypes":{"200":"domain.order.OrderResponse"},"noAuthentication":false,"description":"Order a new domain name","iamActions":[{"name":"account:apiovh:domain/order/create","required":true}]}],"description":""},{"path":"/domain/zone","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getZones","httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List DNS zones","longDescription":"Returns the names of the DNS zones.","iamActions":[{"name":"dnsZone:apiovh:get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getZone","httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.ZoneWithIAM","responseTypes":{"200":"domain.ZoneWithIAM"},"noAuthentication":false,"description":"Get a DNS zone","longDescription":"Returns a DNS zone: name servers, last update date, and whether DNSSEC and DNS Anycast are active.","iamActions":[{"name":"dnsZone:apiovh:get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/capabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Capabilities","responseTypes":{"200":"domain.zone.Capabilities"},"noAuthentication":false,"description":"Get the zone capabilities","longDescription":"Returns whether DynHost is available for the zone.","iamActions":[{"name":"dnsZone:apiovh:capabilities/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/changeContact","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"services.changeContact","paramType":"body","fullType":"services.changeContact","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"Change contacts","longDescription":"Starts the change of the admin, tech or billing contact and returns the request IDs.","iamActions":[{"name":"dnsZone:apiovh:changeContact","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/confirmTermination","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"services.confirmTermination","paramType":"body","fullType":"services.confirmTermination","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Confirm termination","longDescription":"Confirms the termination with the token sent by email. The reason and comments are optional.","iamActions":[{"name":"dnsZone:apiovh:confirmTermination","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dnssec","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"disableDNSSEC","httpMethod":"DELETE","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Disable DNSSEC","longDescription":"Disables DNSSEC on the zone. The status is `disableInProgress` until it completes.","iamActions":[{"name":"dnsZone:apiovh:dnssec/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDNSSECStatus","httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Dnssec","responseTypes":{"200":"domain.zone.Dnssec"},"noAuthentication":false,"description":"Get the DNSSEC status","longDescription":"Returns the DNSSEC status: enabled, disabled, or being enabled or disabled.","iamActions":[{"name":"dnsZone:apiovh:dnssec/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"enableDNSSEC","httpMethod":"POST","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Enable DNSSEC","longDescription":"Enables DNSSEC on the zone. The status is `enableInProgress` until it completes.","iamActions":[{"name":"dnsZone:apiovh:dnssec/create","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dynHost/login","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDynHostLogins","httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of login property (ilike)"},{"name":"subDomain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of subDomain property (ilike)"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List DynHost logins","longDescription":"Returns the DynHost logins of the zone. Can be filtered by login and subdomain.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createDynDnsLogin","httpMethod":"POST","parameters":[{"dataType":"domain.zone.dynHost.LoginCreate","paramType":"body","fullType":"domain.zone.dynHost.LoginCreate","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.dynHost.Login","responseTypes":{"200":"domain.zone.dynHost.Login"},"noAuthentication":false,"description":"Create a DynHost login","longDescription":"Creates a login named from the zone name and a suffix. The subdomain `*` allows all subdomains.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/create","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dynHost/login/{login}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteDynHostLogin","httpMethod":"DELETE","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a DynHost login","longDescription":"Deletes a DynHost login from the zone.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDynHostLogin","httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.dynHost.Login","responseTypes":{"200":"domain.zone.dynHost.Login"},"noAuthentication":false,"description":"Get a DynHost login","longDescription":"Returns a DynHost login: its name and the subdomain it can update.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editDynDnsLogin","httpMethod":"PUT","parameters":[{"dataType":"domain.zone.dynHost.Login","paramType":"body","fullType":"domain.zone.dynHost.Login","required":true,"description":"Request Body"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a DynHost login","longDescription":"Updates the subdomain a DynHost login is allowed to update.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dynHost/login/{login}/changePassword","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"changePasswordDynDnsLogin","httpMethod":"POST","parameters":[{"dataType":"domain.zone.dynHost.LoginChangePassword","paramType":"body","fullType":"domain.zone.dynHost.LoginChangePassword","required":true,"description":"Request Body"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Change a DynHost password","longDescription":"Sets a new password for a DynHost login.","iamActions":[{"name":"dnsZone:apiovh:dynHost/login/changePassword","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dynHost/record","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDynHostRecords","httpMethod":"GET","parameters":[{"name":"subDomain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of subDomain property (ilike)"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List DynHost records","longDescription":"Returns the identifiers of the DynHost records of the zone. Can be filtered by subdomain.","iamActions":[{"name":"dnsZone:apiovh:dynHost/record/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createDynDnsRecord","httpMethod":"POST","parameters":[{"dataType":"domain.zone.dynHost.Record","paramType":"body","fullType":"domain.zone.dynHost.Record","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.dynHost.Record","responseTypes":{"200":"domain.zone.dynHost.Record"},"noAuthentication":false,"description":"Create a DynHost record","longDescription":"Creates a DynHost record with a subdomain, an IP and a TTL.","iamActions":[{"name":"dnsZone:apiovh:dynHost/record/create","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/dynHost/record/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteDynHostRecord","httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a DynHost record","longDescription":"Deletes a DynHost record.","iamActions":[{"name":"dnsZone:apiovh:dynHost/record/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDynHostRecord","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.dynHost.Record","responseTypes":{"200":"domain.zone.dynHost.Record"},"noAuthentication":false,"description":"Get a DynHost record","longDescription":"Returns a DynHost record: subdomain, IP and TTL.","iamActions":[{"name":"dnsZone:apiovh:dynHost/record/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editDynDnsRecord","httpMethod":"PUT","parameters":[{"dataType":"domain.zone.dynHost.Record","paramType":"body","fullType":"domain.zone.dynHost.Record","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a DynHost record","longDescription":"Updates the IP and TTL of a DynHost record.","iamActions":[{"name":"dnsZone:apiovh:dynHost/record/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/export","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Export the zone","longDescription":"Returns the zone content as a zone file.","iamActions":[{"name":"dnsZone:apiovh:export/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/history","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDate.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter using the value of creationDate property (>=)"},{"name":"creationDate.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter using the value of creationDate property (<=)"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"datetime[]","responseTypes":{"200":"datetime[]"},"noAuthentication":false,"description":"List restore points","longDescription":"Returns the creation dates of the zone restore points. Can be filtered by a creation date range.","iamActions":[{"name":"dnsZone:apiovh:history/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/history/{creationDate}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDate","dataType":"datetime","paramType":"path","fullType":"datetime","required":true,"description":"Creation date"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.ZoneRestorePoint","responseTypes":{"200":"domain.zone.ZoneRestorePoint"},"noAuthentication":false,"description":"Get a restore point","longDescription":"Returns a restore point: its creation date and the URL of the saved zone file.","iamActions":[{"name":"dnsZone:apiovh:history/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/history/{creationDate}/restore","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"creationDate","dataType":"datetime","paramType":"path","fullType":"datetime","required":true,"description":"Creation date"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Task","responseTypes":{"200":"domain.zone.Task"},"noAuthentication":false,"description":"Restore the zone","longDescription":"Restores the zone to the selected restore point and returns the task.","iamActions":[{"name":"dnsZone:apiovh:history/restore","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/import","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.zone.Import","paramType":"body","fullType":"domain.zone.Import","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Task","responseTypes":{"200":"domain.zone.Task"},"noAuthentication":false,"description":"Import a zone file","longDescription":"Imports a zone file into the zone and returns the task.","iamActions":[{"name":"dnsZone:apiovh:import","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/option","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List options","longDescription":"Returns the names of the zone options.","iamActions":[{"name":"dnsZone:apiovh:option/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/option/{name}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Option","responseTypes":{"200":"domain.zone.Option"},"noAuthentication":false,"description":"Get an option","longDescription":"Returns a zone option: its name.","iamActions":[{"name":"dnsZone:apiovh:option/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/option/{name}/serviceInfos","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The option name"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your zone"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get this object properties","iamActions":[{"name":"dnsZone:apiovh:option/serviceInfos/get","required":true}]},{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"PUT","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The option name"},{"name":"renew","dataType":"service.RenewType","paramType":"body","fullType":"service.RenewType","required":true,"description":"Renew type"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your zone"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Alter this object properties","iamActions":[{"name":"dnsZone:apiovh:option/serviceInfos/edit","required":true}]}],"description":"serviceInfos operations"},{"path":"/domain/zone/{zoneName}/record","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getRecords","httpMethod":"GET","parameters":[{"name":"fieldType","dataType":"domain.zone.RecordTypeEnum","paramType":"query","fullType":"domain.zone.RecordTypeEnum","required":false,"description":"Filter the value of fieldType property (like)"},{"name":"subDomain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of subDomain property (ilike)"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List records","longDescription":"Returns the identifiers of the zone records. Can be filtered by subdomain and record type.","iamActions":[{"name":"dnsZone:apiovh:record/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createRecord","httpMethod":"POST","parameters":[{"dataType":"domain.zone.RecordCreate","paramType":"body","fullType":"domain.zone.RecordCreate","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Record","responseTypes":{"200":"domain.zone.Record"},"noAuthentication":false,"description":"Create a record","longDescription":"Creates a record in the zone. The change applies after the zone is refreshed.","iamActions":[{"name":"dnsZone:apiovh:record/create","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/record/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteRecord","httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a record","longDescription":"Deletes a record from the zone. The change applies after the zone is refreshed.","iamActions":[{"name":"dnsZone:apiovh:record/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getRecord","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Record","responseTypes":{"200":"domain.zone.Record"},"noAuthentication":false,"description":"Get a record","longDescription":"Returns a record: type, subdomain, target and TTL.","iamActions":[{"name":"dnsZone:apiovh:record/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editRecord","httpMethod":"PUT","parameters":[{"dataType":"domain.zone.RecordUpdate","paramType":"body","fullType":"domain.zone.RecordUpdate","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a record","longDescription":"Updates the subdomain, target and TTL of a record. The change applies after the zone is refreshed.","iamActions":[{"name":"dnsZone:apiovh:record/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/redirection","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getRedirections","httpMethod":"GET","parameters":[{"name":"subDomain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of subDomain property"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List redirections","longDescription":"Returns the identifiers of the zone redirections. Can be filtered by subdomain.","iamActions":[{"name":"dnsZone:apiovh:redirection/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createRedirection","httpMethod":"POST","parameters":[{"dataType":"domain.zone.RedirectionCreate","paramType":"body","fullType":"domain.zone.RedirectionCreate","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Redirection","responseTypes":{"200":"domain.zone.Redirection"},"noAuthentication":false,"description":"Create a redirection","longDescription":"Creates a redirection of type `visible` (HTTP 302), `visiblePermanent` (HTTP 301) or `invisible` (HTML frame). The change applies after the zone is refreshed.","iamActions":[{"name":"dnsZone:apiovh:redirection/create","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/redirection/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteRedirection","httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a redirection","longDescription":"Deletes a redirection. The change applies after the zone is refreshed.","iamActions":[{"name":"dnsZone:apiovh:redirection/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getRedirection","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Redirection","responseTypes":{"200":"domain.zone.Redirection"},"noAuthentication":false,"description":"Get a redirection","longDescription":"Returns a redirection: subdomain, target, type and, for an invisible one, title, description and keywords.","iamActions":[{"name":"dnsZone:apiovh:redirection/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editRedirection","httpMethod":"PUT","parameters":[{"dataType":"domain.zone.RedirectionUpdate","paramType":"body","fullType":"domain.zone.RedirectionUpdate","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a redirection","longDescription":"Updates the target, type, title, description and keywords of a redirection.","iamActions":[{"name":"dnsZone:apiovh:redirection/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/refresh","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"refreshZone","httpMethod":"POST","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Refresh the zone","longDescription":"Applies the pending record changes to the zone.","iamActions":[{"name":"dnsZone:apiovh:refresh","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/reset","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.zone.Reset","paramType":"body","fullType":"domain.zone.Reset","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Reset the zone","longDescription":"Resets the zone, optionally with the records to set afterward. With `minimized`, only the mandatory records are created.","iamActions":[{"name":"dnsZone:apiovh:reset","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get subscription","longDescription":"Returns contacts, creation and expiration dates, and renewal settings.","iamActions":[{"name":"dnsZone:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update renewal settings","longDescription":"Changes how the service renews; `renew` is the only editable field.","iamActions":[{"name":"dnsZone:apiovh:serviceInfos/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/soa","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Soa","responseTypes":{"200":"domain.zone.Soa"},"noAuthentication":false,"description":"Get the SOA record","longDescription":"Returns the SOA of the zone: primary server, administrator email, serial, refresh, expire, TTL and negative-response TTL.","iamActions":[{"name":"dnsZone:apiovh:soa/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"domain.zone.Soa","paramType":"body","fullType":"domain.zone.Soa","required":true,"description":"Request Body"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update the SOA record","longDescription":"Updates the SOA values of the zone.","iamActions":[{"name":"dnsZone:apiovh:soa/edit","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/status","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Status","responseTypes":{"200":"domain.zone.Status"},"noAuthentication":false,"description":"Get the zone status","longDescription":"Returns whether the zone is deployed, with its errors and warnings.","iamActions":[{"name":"dnsZone:apiovh:status/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/task","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"function","dataType":"domain.TaskFunctionEnum","paramType":"query","fullType":"domain.TaskFunctionEnum","required":false,"description":""},{"name":"status","dataType":"domain.TaskStatusEnum","paramType":"query","fullType":"domain.TaskStatusEnum","required":false,"description":""},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List tasks","longDescription":"Returns the identifiers of the zone tasks. Can be filtered by function and status.","iamActions":[{"name":"dnsZone:apiovh:task/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/task/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"domain.zone.Task","responseTypes":{"200":"domain.zone.Task"},"noAuthentication":false,"description":"Get a task","longDescription":"Returns a task: function, status, dates, and whether it can be accelerated, canceled or relaunched.","iamActions":[{"name":"dnsZone:apiovh:task/get","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/task/{id}/accelerate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Accelerate a task","longDescription":"Accelerates a task. Only possible when `canAccelerate` is true on the task.","iamActions":[{"name":"dnsZone:apiovh:task/accelerate","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/task/{id}/cancel","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Cancel a task","longDescription":"Cancels a task. Only possible when `canCancel` is true on the task.","iamActions":[{"name":"dnsZone:apiovh:task/cancel","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/task/{id}/relaunch","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Relaunch a task","longDescription":"Relaunches a task. Only possible when `canRelaunch` is true on the task.","iamActions":[{"name":"dnsZone:apiovh:task/relaunch","required":true}]}],"description":""},{"path":"/domain/zone/{zoneName}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"zoneName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Zone name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Request termination","longDescription":"Emails a termination token to the admin contact, to use with *Confirm termination*.","iamActions":[{"name":"dnsZone:apiovh:terminate","required":true}]}],"description":""},{"path":"/domain/{serviceName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getDomain","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.DomainServiceWithIAM","responseTypes":{"200":"domain.DomainServiceWithIAM"},"noAuthentication":false,"description":"Get domain name information","iamActions":[{"name":"domain:apiovh:get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editDomain","httpMethod":"PUT","parameters":[{"dataType":"domain.DomainService","paramType":"body","fullType":"domain.DomainService","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.DomainService","responseTypes":{"200":"domain.DomainService"},"noAuthentication":false,"description":"Edit domain name properties","iamActions":[{"name":"domain:apiovh:edit","required":true},{"name":"domain:apiovh:name/setProtection","description":"Only domain admin can lock or unlock domain","required":false}]}],"description":""},{"path":"/domain/{serviceName}/authInfo","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"password","responseTypes":{"200":"password"},"noAuthentication":false,"description":"Return authInfo code if the domain is unlocked","iamActions":[{"name":"domain:apiovh:authInfo/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/changeContact","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"services.changeContact","paramType":"body","fullType":"services.changeContact","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"Launch a contact change procedure","iamActions":[{"name":"domain:apiovh:changeContact","required":true}]}],"description":""},{"path":"/domain/{serviceName}/configurations/obfuscatedEmails","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.configurations.ObfuscatedEmail[]","responseTypes":{"200":"domain.configurations.ObfuscatedEmail[]"},"noAuthentication":false,"description":"Retrieve obfuscated emails configuration","iamActions":[{"name":"domain:apiovh:configuration/obfuscatedEmail/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"domain.configurations.ObfuscatedEmailUpdatePayload","paramType":"body","fullType":"domain.configurations.ObfuscatedEmailUpdatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.configurations.ObfuscatedEmail[]","responseTypes":{"200":"domain.configurations.ObfuscatedEmail[]"},"noAuthentication":false,"description":"Save a new obfuscated emails configuration","iamActions":[{"name":"domain:apiovh:configuration/obfuscatedEmail/edit","required":true}]}],"description":""},{"path":"/domain/{serviceName}/configurations/obfuscatedEmails/refresh","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.configurations.ObfuscatedEmailRefreshPayload","paramType":"body","fullType":"domain.configurations.ObfuscatedEmailRefreshPayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Refresh an obfuscated emails configuration with new values","iamActions":[{"name":"domain:apiovh:configuration/obfuscatedEmail/refresh","required":true}]}],"description":""},{"path":"/domain/{serviceName}/configurations/optin","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.configurations.Optin[]","responseTypes":{"200":"domain.configurations.Optin[]"},"noAuthentication":false,"description":"Retrieve optin configuration","iamActions":[{"name":"domain:apiovh:configuration/optin/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"domain.configurations.OptinUpdatePayload","paramType":"body","fullType":"domain.configurations.OptinUpdatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.configurations.Optin[]","responseTypes":{"200":"domain.configurations.Optin[]"},"noAuthentication":false,"description":"Save a new optin configuration","iamActions":[{"name":"domain:apiovh:configuration/optin/edit","required":true}]}],"description":""},{"path":"/domain/{serviceName}/dsRecord","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"flags","dataType":"dnssec.KeyFlagEnum","paramType":"query","fullType":"dnssec.KeyFlagEnum","required":false,"description":"Filter the value of flags property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"status","dataType":"dnssec.KeyStatusEnum","paramType":"query","fullType":"dnssec.KeyStatusEnum","required":false,"description":"Filter the value of status property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List of domain's DS Records","iamActions":[{"name":"domain:apiovh:dsRecord/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"dnssec.UpdatePayload","paramType":"body","fullType":"dnssec.UpdatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Update DS records","iamActions":[{"name":"domain:apiovh:dsRecord/create","required":true}]}],"description":""},{"path":"/domain/{serviceName}/dsRecord/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dnssec.Key","responseTypes":{"200":"dnssec.Key"},"noAuthentication":false,"description":"Get details on this DS Record","iamActions":[{"name":"domain:apiovh:dsRecord/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/glueRecord","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"host","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of host property"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List of glue records","iamActions":[{"name":"domain:apiovh:glueRecord/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.glueRecord.CreatePayload","paramType":"body","fullType":"domain.glueRecord.CreatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Create a glue record","iamActions":[{"name":"domain:apiovh:glueRecord/create","required":true}]}],"description":""},{"path":"/domain/{serviceName}/glueRecord/{host}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"host","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Host"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Delete the glue record","iamActions":[{"name":"domain:apiovh:glueRecord/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"host","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Host"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.glueRecord.GlueRecord","responseTypes":{"200":"domain.glueRecord.GlueRecord"},"noAuthentication":false,"description":"Get this glue record","iamActions":[{"name":"domain:apiovh:glueRecord/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/glueRecord/{host}/update","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.glueRecord.GlueRecord","paramType":"body","fullType":"domain.glueRecord.GlueRecord","required":true,"description":"Request Body"},{"name":"host","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Host"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Update the glue record","iamActions":[{"name":"domain:apiovh:glueRecord/edit","required":true}]}],"description":""},{"path":"/domain/{serviceName}/nameServer","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List of current name servers","iamActions":[{"name":"domain:apiovh:nameServer/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.nameServer.CreatePayload","paramType":"body","fullType":"domain.nameServer.CreatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Add new name server","iamActions":[{"name":"domain:apiovh:nameServer/create","required":true}]}],"description":""},{"path":"/domain/{serviceName}/nameServer/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Delete a name server","iamActions":[{"name":"domain:apiovh:nameServer/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.nameServer.FullNameServer","responseTypes":{"200":"domain.nameServer.FullNameServer"},"noAuthentication":false,"description":"Get this name server configuration","iamActions":[{"name":"domain:apiovh:nameServer/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/nameServer/{id}/status","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.nameServer.NameServerStatus","responseTypes":{"200":"domain.nameServer.NameServerStatus"},"noAuthentication":false,"description":"Get name server status","iamActions":[{"name":"domain:apiovh:nameServer/status/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/nameServers/update","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.nameServer.UpdatePayload","paramType":"body","fullType":"domain.nameServer.UpdatePayload","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Update DNS servers","iamActions":[{"name":"domain:apiovh:nameServer/edit","required":true}]}],"description":""},{"path":"/domain/{serviceName}/option","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.DomainOptionEnum[]","responseTypes":{"200":"domain.DomainOptionEnum[]"},"noAuthentication":false,"description":"List domain options","iamActions":[{"name":"domain:apiovh:option/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/option/{option}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"option","dataType":"domain.DomainOptionEnum","paramType":"path","fullType":"domain.DomainOptionEnum","required":true,"description":"Option"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Remove a given option","iamActions":[{"name":"domain:apiovh:option/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"option","dataType":"domain.DomainOptionEnum","paramType":"path","fullType":"domain.DomainOptionEnum","required":true,"description":"Option"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Option","responseTypes":{"200":"domain.Option"},"noAuthentication":false,"description":"Get details on this domain option","iamActions":[{"name":"domain:apiovh:option/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/options","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.ServiceOptions","responseTypes":{"200":"domain.ServiceOptions"},"noAuthentication":false,"description":"Retrieve data about the options associated to a domain","iamActions":[{"name":"domain:apiovh:options/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/rules/emailsObfuscation","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.configurations.ContactTypeEnum[]","responseTypes":{"200":"domain.configurations.ContactTypeEnum[]"},"noAuthentication":false,"description":"Retrieve emails obfuscation rule","iamActions":[{"name":"domain:apiovh:rule/emailsObfuscation/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/rules/optin","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.rules.Optin[]","responseTypes":{"200":"domain.rules.Optin[]"},"noAuthentication":false,"description":"Retrieve optin rule","iamActions":[{"name":"domain:apiovh:rule/optin/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get service information","iamActions":[{"name":"domain:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update service information","iamActions":[{"name":"domain:apiovh:serviceInfos/edit","required":true}]}],"description":""},{"path":"/domain/{serviceName}/task","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"function","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of function property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"status","dataType":"domain.OperationStatusEnum","paramType":"query","fullType":"domain.OperationStatusEnum","required":false,"description":"Filter the value of status property (=)"},{"name":"type","dataType":"domain.OperationTypeEnum","paramType":"query","fullType":"domain.OperationTypeEnum","required":false,"description":"Filter the value of type property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List all domain tasks","iamActions":[{"name":"domain:apiovh:task/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/task/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Get details about a domain task","iamActions":[{"name":"domain:apiovh:task/get","required":true}]}],"description":""},{"path":"/domain/{serviceName}/task/{id}/accelerate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Accelerate the task","iamActions":[{"name":"domain:apiovh:task/accelerate","required":true}]}],"description":""},{"path":"/domain/{serviceName}/task/{id}/cancel","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Cancel the task","iamActions":[{"name":"domain:apiovh:task/cancel","required":true}]}],"description":""},{"path":"/domain/{serviceName}/task/{id}/relaunch","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Relaunch the task","iamActions":[{"name":"domain:apiovh:task/relaunch","required":true}]}],"description":""},{"path":"/domain/{serviceName}/ukOutgoingTransfer","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"domain.UkRegistrar","paramType":"body","fullType":"domain.UkRegistrar","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.Task","responseTypes":{"200":"domain.Task"},"noAuthentication":false,"description":"Schedule an outgoing transfer task for this domain (.uk only)","iamActions":[{"name":"domain:apiovh:outgoingTransfer/uk/create","required":true}]}],"description":""},{"path":"/domain/{serviceName}/ukRegistrars","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"domain.UkRegistrar[]","responseTypes":{"200":"domain.UkRegistrar[]"},"noAuthentication":false,"description":"Return the list of all .uk registrars","iamActions":[{"name":"domain:apiovh:ukRegistrar/get","required":true}]}],"description":""}],"resourcePath":"/domain","basePath":"https://eu.api.ovh.com/1.0","models":{"dnssec.DnssecStatusEnum":{"id":"DnssecStatusEnum","namespace":"dnssec","description":"Dnssec Status","enum":["disableInProgress","disabled","enableInProgress","enabled"],"enumType":"string"},"dnssec.Key":{"id":"Key","namespace":"dnssec","description":"Domain's DNSSEC Key","properties":{"algorithm":{"type":"dnssec.KeyAlgorithmEnum","fullType":"dnssec.KeyAlgorithmEnum","canBeNull":false,"readOnly":false,"description":"Algorithm number of the DNSSEC key","required":false},"flags":{"type":"dnssec.KeyFlagEnum","fullType":"dnssec.KeyFlagEnum","canBeNull":false,"readOnly":false,"description":"Flag of the DNSSEC key","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"ID of the DNSSEC key","required":false},"publicKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Public key","required":false},"status":{"type":"dnssec.KeyStatusEnum","fullType":"dnssec.KeyStatusEnum","canBeNull":false,"readOnly":true,"description":"Key status of the DNSSEC key","required":false},"tag":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"Tag of the DNSSEC key","required":false}}},"dnssec.KeyAlgorithmEnum":{"id":"KeyAlgorithmEnum","namespace":"dnssec","description":"DNSSEC Algorithm\n3: DSA\n5: RSASHA1\n6: DSA-NSEC3-SHA1\n7: RSASHA1-NSEC3-SHA1\n8: RSASHA256\n10: RSASHA512\n12: ECC-GOST\n13: ECDSAP256SHA256\n14: ECDSAP384SHA384\n15: ED25519\n16: ED448","enum":[3,5,6,7,8,10,12,13,14,15,16],"enumType":"long"},"dnssec.KeyFlagEnum":{"id":"KeyFlagEnum","namespace":"dnssec","description":"DNSSEC Key Flag Type: 256=ZSK (Zone Signing Key), 257=KSK (Key Signing Key)","enum":[256,257],"enumType":"long"},"dnssec.KeyStatusEnum":{"id":"KeyStatusEnum","namespace":"dnssec","description":"Generated: The key has been created, but has not yet been used for anything.\nPublished: The DNSKEY record is published in the zone, but predecessors of the key may be held in caches.\nReady: The new key data has been published for long enough to guarantee that any previous versions of the DNSKEY RRset have expired from caches.\nActive: The key has started to be used to sign RRsets.\nRetired: A successor key has become active and this key is no longer being used to generate RRSIGs.\nRemoved: The key has been removed from the zone.\nRevoked: The key is published for a period with the \"revoke\" bit set as a way of notifying validating resolvers that have configured it as an trust anchor that it is about to be removed from the zone.","enum":["active","generated","published","removed","retired","revoked"],"enumType":"string"},"dnssec.UpdatePayload":{"id":"UpdatePayload","namespace":"dnssec","description":"Payload used to update the DNSSEC keys of a domain name","properties":{"keys":{"type":"dnssec.Key[]","fullType":"dnssec.Key[]","canBeNull":false,"readOnly":false,"description":"New Keys","required":true}}},"domain.ActionEnum":{"id":"ActionEnum","namespace":"domain","description":"An action to execute on a domain name","enum":["create","trade","transfer","update"],"enumType":"string"},"domain.Contact":{"id":"Contact","namespace":"domain","description":"A contact contains the personal data of a user","properties":{"accreditationCountry":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":false,"description":"Country of lawyer accreditation","required":false},"accreditationId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Lawyer accreditation number","required":false},"accreditationOrganism":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Organism of lawyer accreditation","required":false},"accreditationYear":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Year of lawyer accreditation","required":false},"address":{"type":"domain.ContactAddress","fullType":"domain.ContactAddress","canBeNull":true,"readOnly":false,"description":"The address of the contact","required":false},"birthCity":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"City of birth","required":false},"birthCountry":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":false,"description":"Birth Country","required":false},"birthDay":{"type":"date","fullType":"date","canBeNull":true,"readOnly":false,"description":"Birth date","required":false},"birthZip":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Birth Zipcode","required":false},"cellPhone":{"type":"phoneNumber","fullType":"phoneNumber","canBeNull":true,"readOnly":false,"description":"Cellphone number","required":false},"companyNationalIdentificationNumber":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Company National Identification Number","required":false},"email":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Email address","required":false},"enterpriseId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Enterprise identifier","required":false},"fax":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Fax number","required":false},"firstName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"First name","required":false},"gender":{"type":"nichandle.GenderEnum","fullType":"nichandle.GenderEnum","canBeNull":true,"readOnly":false,"description":"Gender","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Unique identifier","required":false},"insee":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"INSEE identifier","required":false},"language":{"type":"nichandle.LanguageEnum","fullType":"nichandle.LanguageEnum","canBeNull":true,"readOnly":false,"description":"Language","required":false},"lastName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Last name","required":false},"legalForm":{"type":"nichandle.LegalFormEnum","fullType":"nichandle.LegalFormEnum","canBeNull":true,"readOnly":false,"required":false},"legalFormCategory":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"category of legalForm","required":false},"nationalIdentificationNumber":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"National Identification Number","required":false},"nationality":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":false,"description":"Nationality","required":false},"organisationAccountable":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"To whom is the organisation accountable","required":false},"organisationFunding":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"What is the source of funding","required":false},"organisationFundingOther":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Explain the source of funding if organisationFunding is other","required":false},"organisationName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Name of organisation","required":false},"organisationRole":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Role of your organisation","required":false},"organisationRoleOther":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Explain the role of your organisation if organisationRole is other","required":false},"organisationStaffStatus":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Status of the staff","required":false},"organisationStaffStatusOther":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Explain the status of the staff if organisationStaffStatus is other","required":false},"organisationType":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"type of organisation","required":false},"organisationTypeOther":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Explain the type of organisation if organisationType is other","required":false},"phone":{"type":"phoneNumber","fullType":"phoneNumber","canBeNull":true,"readOnly":false,"description":"Phone number","required":false},"registrantDocumentType":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Type of registrant document","required":false},"registrantDocumentTypeOther":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Explain the type of registrant document if registrantDocumentType is other","required":false},"roleInOrganisation":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"The role in the organisation","required":false},"trademarkId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Trademark related to the contact","required":false},"vat":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"VAT number","required":false},"website":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Website","required":false}}},"domain.ContactAddress":{"id":"ContactAddress","namespace":"domain","description":"Missing description","properties":{"city":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"City","required":false},"country":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":false,"description":"Country","required":false},"line1":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Address line 1","required":false},"line2":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Address line 2","required":false},"line3":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Address line 3","required":false},"otherDetails":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Others details","required":false},"province":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Province","required":false},"zip":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Zip code","required":false}}},"domain.ContactSummary":{"id":"ContactSummary","namespace":"domain","description":"A contact summary contains the personal data of a user","properties":{"id":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unique contact identifier (contact data can be edited via /me/contact/<ID>)","required":false}}},"domain.Data":{"id":"Data","namespace":"domain","description":"A domain data","properties":{"audience":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain name audience","required":false},"authInfo":{"type":"password","fullType":"password","canBeNull":true,"readOnly":false,"description":"Auth Info","required":false},"isFor":{"type":"domain.IsForEnum[]","fullType":"domain.IsForEnum[]","canBeNull":true,"readOnly":false,"description":"Purposes of the domain","required":false},"otherPurpose":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain name other purpose","required":false},"reason":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Reason of the purchase of this domain","required":false},"represent":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Represented company","required":false}}},"domain.DnssecStateEnum":{"id":"DnssecStateEnum","namespace":"domain","description":"Domain dnssec state","enum":["disabled","enabled","not_supported"],"enumType":"string"},"domain.DnssecStatusEnum":{"id":"DnssecStatusEnum","namespace":"domain","description":"All DNSSEC statuses","enum":["disableInProgress","disabled","enableInProgress","enabled"],"enumType":"string"},"domain.DomainOptionEnum":{"id":"DomainOptionEnum","namespace":"domain","description":"All options a domain can have","enum":["dnsAnycast"],"enumType":"string"},"domain.DomainOptionStateEnum":{"id":"DomainOptionStateEnum","namespace":"domain","description":"All states a domain Option can be in","enum":["released","subscribed"],"enumType":"string"},"domain.DomainService":{"id":"DomainService","namespace":"domain","description":"General information about a domain name service","properties":{"contactAdmin":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Administrative contact data","required":false},"contactBilling":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Billing contact data","required":false},"contactOwner":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Owner (registrant) contact data","required":false},"contactTech":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Technical contact data","required":false},"dnssecState":{"type":"domain.DnssecStateEnum","fullType":"domain.DnssecStateEnum","canBeNull":false,"readOnly":true,"description":"Current DNSSEC state of the domain name","required":false},"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether DNSSEC is activated for this domain name","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain name","required":false},"expirationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date when the domain name will expire, if not renewed","required":false},"glueRecordIpv6Supported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports IPv6 glue records","required":false},"glueRecordMultiIpSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports multi-ip glue records","required":false},"hostSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports hosts as independent entities","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date","required":false},"nameServerType":{"type":"domain.nameServer.NameServerTypeEnum","fullType":"domain.nameServer.NameServerTypeEnum","canBeNull":false,"readOnly":false,"description":"Name servers type","required":false},"nameServers":{"type":"domain.nameServer.NameServer[]","fullType":"domain.nameServer.NameServer[]","canBeNull":false,"readOnly":true,"description":"Name servers list","required":false},"offer":{"type":"domain.OfferEnum","fullType":"domain.OfferEnum","canBeNull":false,"readOnly":true,"description":"Offer associated with the domain name","required":false},"owoSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether Whois data obfuscation is supported for this domain name","required":false},"parentService":{"type":"domain.ParentService","fullType":"domain.ParentService","canBeNull":true,"readOnly":true,"description":"Parent service","required":false},"renewalDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date when the domain name should be renewed (relevant if renewalState is automatic_renew)","required":false},"renewalState":{"type":"domain.RenewalStateEnum","fullType":"domain.RenewalStateEnum","canBeNull":false,"readOnly":true,"description":"Current renewal state of the domain name","required":false},"serviceId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Technical service identifier","required":false},"state":{"type":"domain.DomainStateEnum","fullType":"domain.DomainStateEnum","canBeNull":false,"readOnly":true,"description":"Current state of the domain name","required":false},"suspensionState":{"type":"domain.SuspensionStateEnum","fullType":"domain.SuspensionStateEnum","canBeNull":false,"readOnly":true,"description":"Current suspension state of the domain name","required":false},"transferLockStatus":{"type":"domain.LockStatusEnum","fullType":"domain.LockStatusEnum","canBeNull":false,"readOnly":false,"description":"Current transfer lock status of the domain name","required":false},"whoisOwner":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Owner (registrant) contact ID (contact data can be edited via /me/contact/<ID>)","required":false}}},"domain.DomainServiceWithIAM":{"id":"DomainService","namespace":"domain","description":"General information about a domain name service","properties":{"contactAdmin":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Administrative contact data","required":false},"contactBilling":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Billing contact data","required":false},"contactOwner":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Owner (registrant) contact data","required":false},"contactTech":{"type":"domain.ContactSummary","fullType":"domain.ContactSummary","canBeNull":false,"readOnly":true,"description":"Technical contact data","required":false},"dnssecState":{"type":"domain.DnssecStateEnum","fullType":"domain.DnssecStateEnum","canBeNull":false,"readOnly":true,"description":"Current DNSSEC state of the domain name","required":false},"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether DNSSEC is activated for this domain name","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain name","required":false},"expirationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date when the domain name will expire, if not renewed","required":false},"glueRecordIpv6Supported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports IPv6 glue records","required":false},"glueRecordMultiIpSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports multi-ip glue records","required":false},"hostSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the registry supports hosts as independent entities","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date","required":false},"nameServerType":{"type":"domain.nameServer.NameServerTypeEnum","fullType":"domain.nameServer.NameServerTypeEnum","canBeNull":false,"readOnly":false,"description":"Name servers type","required":false},"nameServers":{"type":"domain.nameServer.NameServer[]","fullType":"domain.nameServer.NameServer[]","canBeNull":false,"readOnly":true,"description":"Name servers list","required":false},"offer":{"type":"domain.OfferEnum","fullType":"domain.OfferEnum","canBeNull":false,"readOnly":true,"description":"Offer associated with the domain name","required":false},"owoSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether Whois data obfuscation is supported for this domain name","required":false},"parentService":{"type":"domain.ParentService","fullType":"domain.ParentService","canBeNull":true,"readOnly":true,"description":"Parent service","required":false},"renewalDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date when the domain name should be renewed (relevant if renewalState is automatic_renew)","required":false},"renewalState":{"type":"domain.RenewalStateEnum","fullType":"domain.RenewalStateEnum","canBeNull":false,"readOnly":true,"description":"Current renewal state of the domain name","required":false},"serviceId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Technical service identifier","required":false},"state":{"type":"domain.DomainStateEnum","fullType":"domain.DomainStateEnum","canBeNull":false,"readOnly":true,"description":"Current state of the domain name","required":false},"suspensionState":{"type":"domain.SuspensionStateEnum","fullType":"domain.SuspensionStateEnum","canBeNull":false,"readOnly":true,"description":"Current suspension state of the domain name","required":false},"transferLockStatus":{"type":"domain.LockStatusEnum","fullType":"domain.LockStatusEnum","canBeNull":false,"readOnly":false,"description":"Current transfer lock status of the domain name","required":false},"whoisOwner":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Owner (registrant) contact ID (contact data can be edited via /me/contact/<ID>)","required":false}}},"domain.DomainStateEnum":{"id":"DomainStateEnum","namespace":"domain","description":"Domain name current state","enum":["autorenew_in_progress","autorenew_registry_in_progress","deleted","dispute","expired","ok","outgoing_transfer","pending_create","pending_delete","pending_incoming_transfer","pending_installation","registry_suspended","restorable","technical_suspended"],"enumType":"string"},"domain.IsForEnum":{"id":"IsForEnum","namespace":"domain","description":"Possible purposes of the domain","enum":["campaign_website","educational_website","emails","information_website","other_purpose","redirect_page","transactional_website"],"enumType":"string"},"domain.LockStatusEnum":{"id":"LockStatusEnum","namespace":"domain","description":"Domain lock status","enum":["locked","locking","unavailable","unlocked","unlocking"],"enumType":"string"},"domain.OfferEnum":{"id":"OfferEnum","namespace":"domain","description":"Offer","enum":["diamond","gold","platinum"],"enumType":"string"},"domain.OperationStatusEnum":{"id":"OperationStatusEnum","namespace":"domain","description":"Operation status","enum":["cancelled","doing","done","error","problem","todo"],"enumType":"string"},"domain.OperationTypeEnum":{"id":"OperationTypeEnum","namespace":"domain","description":"Operation type","enum":["alldom","domain"],"enumType":"string"},"domain.OptinFieldsEnum":{"id":"OptinFieldsEnum","namespace":"domain","description":"Whois optin fields","enum":["address","city","country","email","fax","name","organisation","phone","province","zip"],"enumType":"string"},"domain.Option":{"id":"Option","namespace":"domain","description":"Information about the options of a domain","properties":{"expirationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Expiration date of the option","required":false},"option":{"type":"domain.DomainOptionEnum","fullType":"domain.DomainOptionEnum","canBeNull":false,"readOnly":true,"description":"The option name","required":false},"state":{"type":"domain.DomainOptionStateEnum","fullType":"domain.DomainOptionStateEnum","canBeNull":false,"readOnly":true,"description":"The state of the option","required":false}}},"domain.ParentService":{"id":"ParentService","namespace":"domain","description":"Parent service","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the parent service","required":false},"type":{"type":"domain.ParentServiceTypeEnum","fullType":"domain.ParentServiceTypeEnum","canBeNull":false,"readOnly":true,"description":"Type of the parent service","required":false}}},"domain.ParentServiceTypeEnum":{"id":"ParentServiceTypeEnum","namespace":"domain","description":"Parent service type enum","enum":["/allDom"],"enumType":"string"},"domain.RenewalStateEnum":{"id":"RenewalStateEnum","namespace":"domain","description":"Domain renewal state","enum":["automatic_renew","cancellation_complete","cancellation_requested","manual_renew","unpaid"],"enumType":"string"},"domain.ServiceOption":{"id":"ServiceOption","namespace":"domain","description":"Data of a domain option","properties":{"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Service name of the option","required":false}}},"domain.ServiceOptions":{"id":"ServiceOptions","namespace":"domain","description":"Representation of the domain options","properties":{"hosting":{"type":"domain.ServiceOption","fullType":"domain.ServiceOption","canBeNull":true,"readOnly":true,"description":"Hosting option","required":false},"offer":{"type":"domain.ServiceOption","fullType":"domain.ServiceOption","canBeNull":true,"readOnly":true,"description":"Offer option (Diamond, Platinum)","required":false},"zone":{"type":"domain.ServiceOption","fullType":"domain.ServiceOption","canBeNull":true,"readOnly":true,"description":"DNS zone option","required":false}}},"domain.SuspensionStateEnum":{"id":"SuspensionStateEnum","namespace":"domain","description":"Domain suspension state","enum":["not_suspended","suspended"],"enumType":"string"},"domain.Task":{"id":"Task","namespace":"domain","description":"Tasks associated to domain","properties":{"canAccelerate":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can accelerate the task","required":false},"canCancel":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can cancel the task","required":false},"canRelaunch":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can relaunch the task","required":false},"comment":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Comment about the task","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the task","required":false},"domain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Domain of the task","required":false},"doneDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Done date of the task","required":false},"function":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Function of the task","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the task","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date of the task","required":false},"status":{"type":"domain.OperationStatusEnum","fullType":"domain.OperationStatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the task","required":false},"todoDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Todo date of the task","required":false},"type":{"type":"domain.OperationTypeEnum","fullType":"domain.OperationTypeEnum","canBeNull":false,"readOnly":true,"description":"type of the task","required":false}}},"domain.TaskFunctionEnum":{"id":"TaskFunctionEnum","namespace":"domain","description":"All functions from a dns task","enum":["DnsAnycastActivate","DnsAnycastDeactivate","DnssecDisable","DnssecEnable","DnssecResigning","DnssecRollKsk","DnssecRollZsk","ZoneCheck","ZoneCreate","ZoneCut","ZoneDelete","ZoneImport","ZoneRefresh","ZoneRestore"],"enumType":"string"},"domain.TaskStatusEnum":{"id":"TaskStatusEnum","namespace":"domain","description":"All statuses from a dns task","enum":["cancelled","doing","done","error","problem","todo"],"enumType":"string"},"domain.UkRegistrar":{"id":"UkRegistrar","namespace":"domain","description":"Representation of a UK Registrar (used for outgoing transfer)","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Registrar name","required":false},"tag":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Registrar tag","required":true}}},"domain.Zone":{"id":"Zone","namespace":"domain","description":"DNS zone","properties":{"dnssecActivated":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC activated for this zone","required":false},"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC supported by this zone","required":false},"hasDnsAnycast":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the DNS zone has a DNS Anycast subscription","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Last update date of the DNS zone","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone name","required":false},"nameServers":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Name servers that host the DNS zone","required":false}}},"domain.ZoneWithIAM":{"id":"Zone","namespace":"domain","description":"DNS zone","properties":{"dnssecActivated":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC activated for this zone","required":false},"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC supported by this zone","required":false},"hasDnsAnycast":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the DNS zone has a DNS Anycast subscription","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Last update date of the DNS zone","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone name","required":false},"nameServers":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Name servers that host the DNS zone","required":false}}},"domain.configuration.rules.Constraint":{"id":"Constraint","namespace":"domain.configuration.rules","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":{"type":"domain.configuration.rules.Rule","fullType":"domain.configuration.rules.Rule","canBeNull":true,"readOnly":true,"description":"Whether this constraint is applied or not","required":false},"contexts":{"type":"domain.configuration.rules.ContextEnum[]","fullType":"domain.configuration.rules.ContextEnum[]","canBeNull":true,"readOnly":true,"description":"The context on which the constraint applies","required":false},"operator":{"type":"domain.configuration.rules.OperatorEnum","fullType":"domain.configuration.rules.OperatorEnum","canBeNull":true,"readOnly":true,"description":"The operator of the constraint","required":false},"value":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The value to match against","required":false},"values":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":true,"description":"The values to match against","required":false}}},"domain.configuration.rules.ContextEnum":{"id":"ContextEnum","namespace":"domain.configuration.rules","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"],"enumType":"string"},"domain.configuration.rules.OperatorEnum":{"id":"OperatorEnum","namespace":"domain.configuration.rules","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"],"enumType":"string"},"domain.configuration.rules.Rule":{"id":"Rule","namespace":"domain.configuration.rules","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":"domain.configuration.rules.Rule[]","fullType":"domain.configuration.rules.Rule[]","canBeNull":true,"readOnly":true,"description":"An \"and\" operator on multiple rules","required":false},"conditions":{"type":"domain.configuration.rules.Rule","fullType":"domain.configuration.rules.Rule","canBeNull":true,"readOnly":true,"description":"Whether this rule is applied or not","required":false},"constraints":{"type":"domain.configuration.rules.Constraint[]","fullType":"domain.configuration.rules.Constraint[]","canBeNull":true,"readOnly":true,"description":"The constraints of the rule","required":false},"contexts":{"type":"domain.configuration.rules.ContextEnum[]","fullType":"domain.configuration.rules.ContextEnum[]","canBeNull":true,"readOnly":true,"description":"The context on which the rule applies","required":false},"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The description of the rule","required":false},"fields":{"type":"domain.configuration.rules.Rule","fullType":"domain.configuration.rules.Rule","canBeNull":true,"readOnly":true,"description":"The fields with specific rules","required":false},"label":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The label of the rule","required":false},"or":{"type":"domain.configuration.rules.Rule[]","fullType":"domain.configuration.rules.Rule[]","canBeNull":true,"readOnly":true,"description":"An \"or\" operator on multiple rules","required":false},"placeholder":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The default value used for the rule","required":false},"type":{"type":"domain.configuration.rules.TypeEnum","fullType":"domain.configuration.rules.TypeEnum","canBeNull":true,"readOnly":true,"description":"The type of the object the rule applies on","required":false}}},"domain.configuration.rules.RuleData":{"id":"RuleData","namespace":"domain.configuration.rules","description":"A rule data contains the fields that must be validated against a rule","properties":{"adminAccount":{"type":"nichandle.Nichandle","fullType":"nichandle.Nichandle","canBeNull":true,"readOnly":false,"description":"The admin contact data","required":false},"domain":{"type":"domain.Data","fullType":"domain.Data","canBeNull":true,"readOnly":false,"description":"The domain data","required":false},"extras":{"type":"domain.configuration.rules.RuleExtraData","fullType":"domain.configuration.rules.RuleExtraData","canBeNull":true,"readOnly":false,"description":"The extra data of the rule","required":false},"owner":{"type":"domain.Contact","fullType":"domain.Contact","canBeNull":true,"readOnly":false,"description":"The owner contact data","required":false},"techAccount":{"type":"nichandle.Nichandle","fullType":"nichandle.Nichandle","canBeNull":true,"readOnly":false,"description":"The tech contact data","required":false}}},"domain.configuration.rules.RuleExtraData":{"id":"RuleExtraData","namespace":"domain.configuration.rules","description":"The extra data contain additional rule data fields","properties":{"acceptCondition":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Whether you accept the domain specific conditions or not","required":false},"authInfo":{"type":"password","fullType":"password","canBeNull":true,"readOnly":false,"description":"The auth info code for the domain","required":false}}},"domain.configuration.rules.TypeEnum":{"id":"TypeEnum","namespace":"domain.configuration.rules","description":"Type of rule configuration","enum":["bool","contact","date_ISO8601","domain","json","number","string","string[]","text"],"enumType":"string"},"domain.configurations.ContactTypeEnum":{"id":"ContactTypeEnum","namespace":"domain.configurations","description":"The possible types of contacts associated to a domain name","enum":["admin","all","billing","owner","tech"],"enumType":"string"},"domain.configurations.CustomFields":{"id":"CustomFields","namespace":"domain.configurations","description":"Representation of the domain custom fields","properties":{"audience":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain name audience","required":false},"authInfo":{"type":"password","fullType":"password","canBeNull":true,"readOnly":true,"description":"Auth Info","required":false},"isFor":{"type":"domain.IsForEnum[]","fullType":"domain.IsForEnum[]","canBeNull":true,"readOnly":false,"description":"Purposes of the domain","required":false},"otherPurpose":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain name other purpose","required":false},"reason":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Reason of the purchase of this domain","required":false},"represent":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Represented company","required":false}}},"domain.configurations.CustomFieldsUpdatePayload":{"id":"CustomFieldsUpdatePayload","namespace":"domain.configurations","description":"Payload used to update the custom fields of a domain name","properties":{"customFields":{"type":"domain.configurations.CustomFields","fullType":"domain.configurations.CustomFields","canBeNull":false,"readOnly":false,"description":"New domain custom fields","required":false}}},"domain.configurations.ObfuscatedEmail":{"id":"ObfuscatedEmail","namespace":"domain.configurations","description":"Configuration of the email obfuscations for contacts related to a domain name","properties":{"status":{"type":"domain.configurations.ObfuscationStatusEnum","fullType":"domain.configurations.ObfuscationStatusEnum","canBeNull":true,"readOnly":true,"description":"Status of the email obfuscation","required":false},"type":{"type":"domain.configurations.ContactTypeEnum","fullType":"domain.configurations.ContactTypeEnum","canBeNull":false,"readOnly":true,"description":"Type of the contact whose email is obfuscated by this configuration","required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Obfuscated email address","required":false}}},"domain.configurations.ObfuscatedEmailRefreshPayload":{"id":"ObfuscatedEmailRefreshPayload","namespace":"domain.configurations","description":"Payload used to request the regeneration of obfuscated email redirections for the provided contacts of a domain name","properties":{"contacts":{"type":"domain.configurations.ContactTypeEnum[]","fullType":"domain.configurations.ContactTypeEnum[]","canBeNull":false,"readOnly":false,"description":"Type of the contacts to refresh email obfuscation for","required":true}}},"domain.configurations.ObfuscatedEmailUpdatePayload":{"id":"ObfuscatedEmailUpdatePayload","namespace":"domain.configurations","description":"Payload used to request the email obfuscation of contacts related to a domain name","properties":{"contacts":{"type":"domain.configurations.ContactTypeEnum[]","fullType":"domain.configurations.ContactTypeEnum[]","canBeNull":false,"readOnly":false,"description":"Type of the contacts to request email obfuscation for","required":true}}},"domain.configurations.ObfuscationStatusEnum":{"id":"ObfuscationStatusEnum","namespace":"domain.configurations","description":"The possible statuses of an email obfuscation","enum":["done","todo"],"enumType":"string"},"domain.configurations.Optin":{"id":"Optin","namespace":"domain.configurations","description":"Configuration of the optin fields for contacts related to a domain name","properties":{"fields":{"type":"domain.OptinFieldsEnum[]","fullType":"domain.OptinFieldsEnum[]","canBeNull":false,"readOnly":false,"description":"Fields to display publicly on the Whois","required":false},"type":{"type":"domain.configurations.ContactTypeEnum","fullType":"domain.configurations.ContactTypeEnum","canBeNull":false,"readOnly":false,"description":"Type of the contact associated to the optin configuration","required":false}}},"domain.configurations.OptinUpdatePayload":{"id":"OptinUpdatePayload","namespace":"domain.configurations","description":"Payload used to optin the fields of contacts related to a domain name","properties":{"optin":{"type":"domain.configurations.Optin[]","fullType":"domain.configurations.Optin[]","canBeNull":false,"readOnly":false,"description":"New optin configuration","required":false}}},"domain.data.claimNotice.Address":{"id":"Address","namespace":"domain.data.claimNotice","description":"Address for a claim notice holder","properties":{"city":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"City","required":false},"countryCode":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":true,"description":"Country code","required":false},"fax":{"type":"phoneNumber","fullType":"phoneNumber","canBeNull":true,"readOnly":true,"description":"Fax number","required":false},"faxExtension":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Fax number extension","required":false},"postalCode":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Postal zip code","required":false},"stateOrProvince":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"State of province","required":false},"streets":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Array of street name","required":false},"voice":{"type":"phoneNumber","fullType":"phoneNumber","canBeNull":true,"readOnly":true,"description":"Phone number","required":false},"voiceExtension":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Phone number extension","required":false}}},"domain.data.claimNotice.ClaimNotice":{"id":"ClaimNotice","namespace":"domain.data.claimNotice","description":"Definition of claim notices applying to a domain name","properties":{"claims":{"type":"domain.data.claimNotice.ClaimNoticeDecision[]","fullType":"domain.data.claimNotice.ClaimNoticeDecision[]","canBeNull":true,"readOnly":true,"description":"Array of claim notice for the domain","required":false},"endingDate":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Ending date of claim notice","required":false},"id":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Claim notice ID","required":false},"label":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Label referring to claim notice","required":false},"startingDate":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Beginning date of claim notice","required":false},"type":{"type":"domain.data.claimNotice.ClaimNoticeTypeEnum","fullType":"domain.data.claimNotice.ClaimNoticeTypeEnum","canBeNull":true,"readOnly":true,"description":"Type of claim notice","required":false}}},"domain.data.claimNotice.ClaimNoticeDecision":{"id":"ClaimNoticeDecision","namespace":"domain.data.claimNotice","description":"Definition of a single claim notice","properties":{"classifications":{"type":"domain.data.claimNotice.Classification[]","fullType":"domain.data.claimNotice.Classification[]","canBeNull":false,"readOnly":true,"description":"Classifications where trademark claim notice apply","required":false},"courtDecisions":{"type":"domain.data.claimNotice.CourtDecision[]","fullType":"domain.data.claimNotice.CourtDecision[]","canBeNull":false,"readOnly":true,"description":"Array of court decisions related to claim notice","required":false},"goodsAndServices":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Goods and services on which apply claim notice","required":false},"jurisdiction":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of jurisdiction","required":false},"jurisdictionCountryCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Jurisdiction country code","required":false},"markName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Mark name implicated in claim notice","required":false},"trademarkContacts":{"type":"domain.data.claimNotice.Contact[]","fullType":"domain.data.claimNotice.Contact[]","canBeNull":false,"readOnly":true,"description":"Trademark contacts","required":false},"trademarkHolders":{"type":"domain.data.claimNotice.Contact[]","fullType":"domain.data.claimNotice.Contact[]","canBeNull":false,"readOnly":true,"description":"Trademark holders","required":false},"trademarkUDRP":{"type":"domain.data.claimNotice.UDRP[]","fullType":"domain.data.claimNotice.UDRP[]","canBeNull":false,"readOnly":true,"description":"Trademark UDRP information","required":false}}},"domain.data.claimNotice.ClaimNoticeTypeEnum":{"id":"ClaimNoticeTypeEnum","namespace":"domain.data.claimNotice","description":"Type of claim notice","enum":["TRADEMARK","UK"],"enumType":"string"},"domain.data.claimNotice.Classification":{"id":"Classification","namespace":"domain.data.claimNotice","description":"Definition of a trademark claim notice classification","properties":{"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Summary of the classification","required":false},"number":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Code of the classification","required":false}}},"domain.data.claimNotice.Contact":{"id":"Contact","namespace":"domain.data.claimNotice","description":"Contact definition of a claim notice holder","properties":{"address":{"type":"domain.data.claimNotice.Address","fullType":"domain.data.claimNotice.Address","canBeNull":false,"readOnly":true,"description":"Address of holder","required":false},"email":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Email address","required":false},"entitlement":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Legitimacy of holder","required":false},"name":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Name of claim notice holder","required":false},"organisation":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Organisation name","required":false},"type":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Type of contact","required":false}}},"domain.data.claimNotice.CourtDecision":{"id":"CourtDecision","namespace":"domain.data.claimNotice","description":"Definition of a court decision","properties":{"countryCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Country code","required":false},"courtName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Court name","required":false},"referenceNumber":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Reference number of court decision","required":false},"regions":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Regions where court decision apply","required":false}}},"domain.data.claimNotice.UDRP":{"id":"UDRP","namespace":"domain.data.claimNotice","description":"Definition of a UDRP procedure","properties":{"caseNumber":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Case number","required":false},"udrpProvider":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"UDRP Provider","required":false}}},"domain.data.smd.Smd":{"id":"Smd","namespace":"domain.data.smd","description":"Representation of a SMD file","properties":{"data":{"type":"text","fullType":"text","canBeNull":false,"readOnly":true,"description":"SMD file content","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"UUID of SMD file","required":false},"notAfter":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date when information about SMD file aren't valid anymore","required":false},"notBefore":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date before when information about SMD file aren't valid yet","required":false},"protectedLabels":{"type":"domain.data.smd.SmdLabel[]","fullType":"domain.data.smd.SmdLabel[]","canBeNull":false,"readOnly":true,"description":"List of the labels that are protect with that SMD file","required":false},"smdId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"TMCH Internal identifier","required":false}}},"domain.data.smd.SmdBody":{"id":"SmdBody","namespace":"domain.data.smd","description":"Representation of a SMD file","properties":{"data":{"type":"text","fullType":"text","canBeNull":false,"readOnly":false,"description":"SMD file content in base64","required":true}}},"domain.data.smd.SmdLabel":{"id":"SmdLabel","namespace":"domain.data.smd","description":"Representation of a protected label","properties":{"label":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Label that is protected","required":false},"trademark":{"type":"text","fullType":"text","canBeNull":false,"readOnly":true,"description":"Trademark associated to the protected label","required":false}}},"domain.extensions.CategoryNameWithExtensions":{"id":"CategoryNameWithExtensions","namespace":"domain.extensions","description":"Result of extensions by category request","properties":{"extensions":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"List of extensions","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the category","required":false}}},"domain.extensions.CategoryTypeEnum":{"id":"CategoryTypeEnum","namespace":"domain.extensions","description":"Type of extension category","enum":["geolocalization","thematic"],"enumType":"string"},"domain.extensions.Extension":{"id":"Extension","namespace":"domain.extensions","description":"A domain name extension","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The extension name","required":false}}},"domain.extensions.ExtensionsByCategory":{"id":"ExtensionsByCategory","namespace":"domain.extensions","description":"Result of extensions by category request","properties":{"geolocalization":{"type":"domain.extensions.CategoryNameWithExtensions[]","fullType":"domain.extensions.CategoryNameWithExtensions[]","canBeNull":true,"readOnly":true,"description":"Geolocalizations groups extensions by geographical place, like 'europe'","required":false},"thematic":{"type":"domain.extensions.CategoryNameWithExtensions[]","fullType":"domain.extensions.CategoryNameWithExtensions[]","canBeNull":true,"readOnly":true,"description":"Thematics groups extensions by a thematic like 'gastronomy' for '.pizza'","required":false}}},"domain.extensions.ExtensionsPricingAttributes":{"id":"ExtensionsPricingAttributes","namespace":"domain.extensions","description":"Result of getting pricing attributes of an extension","properties":{"brandNew":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Parameter is true when the extension has been created recently and we want to highlight this fact","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Extension name, like 'com' or 'co.uk'","required":false},"priceDrop":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Parameter is true when the extension price has dropped recently and we want to highlight this fact","required":false}}},"domain.extensions.OrderByTypeEnum":{"id":"OrderByTypeEnum","namespace":"domain.extensions","description":"Type used to change the order of extensions results","enum":["alphabetical","trending"],"enumType":"string"},"domain.extensions.registryConfigurations.CreateLifecycleRegistryConfiguration":{"id":"CreateLifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied when creating a domain name","properties":{"allowedPeriodsInMonths":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"The number of months allowed for a domain creation","required":false}}},"domain.extensions.registryConfigurations.DNSRegistryConfiguration":{"id":"DNSRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied to the DNS of a domain name","properties":{"isDNSSECSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether DNSSEC is supported by the registry/backend and handled by OVHcloud","required":false},"maxNumber":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The maximum required number of DNS","required":false},"minNumber":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The minimum required number of DNS","required":false}}},"domain.extensions.registryConfigurations.DomainRegistryConfiguration":{"id":"DomainRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied to a domain name","properties":{"extension_type":{"type":"domain.extensions.registryConfigurations.ExtensionTypeEnum","fullType":"domain.extensions.registryConfigurations.ExtensionTypeEnum","canBeNull":false,"readOnly":true,"description":"The type of an extension (cctld or gtld)","required":false},"isAuthInfoSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"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","required":false},"isPremiumSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether premium domains are supported by the registry and handled by OVHcloud","required":false},"label":{"type":"domain.extensions.registryConfigurations.LabelDomainRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.LabelDomainRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied to the domain name label","required":false}}},"domain.extensions.registryConfigurations.ExtensionTypeEnum":{"id":"ExtensionTypeEnum","namespace":"domain.extensions.registryConfigurations","description":"The type of an extension (country-code TLD or generic TLD)","enum":["cctld","gtld"],"enumType":"string"},"domain.extensions.registryConfigurations.LabelDomainRegistryConfiguration":{"id":"LabelDomainRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied to the domain name label","properties":{"isIDNSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether International Domain Names are supported by the registry and handled by OVHcloud","required":false},"maxLength":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The maximum length allowed for a domain name (without the extension)","required":false},"minLength":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The minimum length allowed for a domain name (without the extension)","required":false}}},"domain.extensions.registryConfigurations.LifecycleRegistryConfiguration":{"id":"LifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations of the lifecycle of a domain name","properties":{"create":{"type":"domain.extensions.registryConfigurations.CreateLifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.CreateLifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied when creating a domain name","required":false},"order":{"type":"domain.extensions.registryConfigurations.OrderLifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.OrderLifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied when ordering a domain name","required":false},"renew":{"type":"domain.extensions.registryConfigurations.RenewLifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.RenewLifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied when renewing a domain name","required":false},"restore":{"type":"domain.extensions.registryConfigurations.RestoreLifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.RestoreLifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied when restoring a domain name","required":false},"transfer":{"type":"domain.extensions.registryConfigurations.TransferLifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.TransferLifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"The registry configurations applied when transfering a domain name","required":false}}},"domain.extensions.registryConfigurations.OrderLifecycleRegistryConfiguration":{"id":"OrderLifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied when ordering a domain name","properties":{"active":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"True if the extension can be ordered from the website","required":false},"maxMonths":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The maximum number of months a domain can be ordered for","required":false},"minMonths":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The minimum number of months a domain can be ordered for","required":false}}},"domain.extensions.registryConfigurations.RegistryConfigurations":{"id":"RegistryConfigurations","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied to a domain extension (TLD, SLD)","properties":{"dns":{"type":"domain.extensions.registryConfigurations.DNSRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.DNSRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"Configurations on the DNS associated to the domain for the given extension","required":false},"domain":{"type":"domain.extensions.registryConfigurations.DomainRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.DomainRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"Configurations on the domain name itself for the given extension","required":false},"lifecycle":{"type":"domain.extensions.registryConfigurations.LifecycleRegistryConfiguration","fullType":"domain.extensions.registryConfigurations.LifecycleRegistryConfiguration","canBeNull":false,"readOnly":true,"description":"Configurations on the lifecycle of a domain for the given extension","required":false}}},"domain.extensions.registryConfigurations.RenewLifecycleRegistryConfiguration":{"id":"RenewLifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied when renewing a domain name","properties":{"allowedPeriodsInMonths":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"The number of months allowed for a domain renewal","required":false},"gracePeriodInDays":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"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.","required":false}}},"domain.extensions.registryConfigurations.RestoreLifecycleRegistryConfiguration":{"id":"RestoreLifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied when restoring a domain name","properties":{"gracePeriodInDays":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"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.","required":false}}},"domain.extensions.registryConfigurations.TransferLifecycleRegistryConfiguration":{"id":"TransferLifecycleRegistryConfiguration","namespace":"domain.extensions.registryConfigurations","description":"The registry configurations applied when transfering a domain name","properties":{"allowedPeriodsInMonths":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"The number of months allowed for a domain transfer","required":false},"includeRenew":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the transfer includes a renewal of the domain name, and therefore updates its expiration date","required":false},"incomingTransferDelayMaxDays":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The maximum estimated number of days for an incoming domain transfer","required":false},"incomingTransferDelayMinDays":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The minimum estimated number of days for an incoming domain transfer","required":false},"isAuthInfoRequired":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"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","required":false},"transferBlockDelayInDays":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"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.","required":false}}},"domain.glueRecord.CreatePayload":{"id":"CreatePayload","namespace":"domain.glueRecord","description":"Payload used to create the glue records of a domain name","properties":{"host":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Host of the glue record","required":true},"ips":{"type":"ip[]","fullType":"ip[]","canBeNull":false,"readOnly":false,"description":"IP addresses of the glue record","required":true}}},"domain.glueRecord.GlueRecord":{"id":"GlueRecord","namespace":"domain.glueRecord","description":"Glue record","properties":{"host":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Host of the glue record","required":false},"ips":{"type":"ip[]","fullType":"ip[]","canBeNull":false,"readOnly":false,"description":"IP address","required":true}}},"domain.nameServer.CreatePayload":{"id":"CreatePayload","namespace":"domain.nameServer","description":"Payload used to update the DNS of a domain name","properties":{"nameServer":{"type":"domain.nameServer.NameServerInput[]","fullType":"domain.nameServer.NameServerInput[]","canBeNull":false,"readOnly":false,"description":"Name servers to create","required":true}}},"domain.nameServer.FullNameServer":{"id":"FullNameServer","namespace":"domain.nameServer","description":"Full name server configuration","properties":{"host":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Host of the name server","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"ID of the name server","required":false},"ip":{"type":"ip","fullType":"ip","canBeNull":true,"readOnly":true,"description":"IP address of the name server","required":false},"isUsed":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"isUsed flag of the name server","required":false},"toDelete":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"toDelete flag of the name server","required":false}}},"domain.nameServer.NameServer":{"id":"NameServer","namespace":"domain.nameServer","description":"Name server configuration","properties":{"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"ID of the name server","required":false},"ipv4":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"IPv4 adress of the name server","required":false},"ipv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"IPv6 adress  of the name server","required":false},"nameServer":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the name server","required":false},"nameServerType":{"type":"domain.nameServer.NameServerTypeEnum","fullType":"domain.nameServer.NameServerTypeEnum","canBeNull":false,"readOnly":true,"description":"Type of the name server","required":false}}},"domain.nameServer.NameServerInput":{"id":"NameServerInput","namespace":"domain.nameServer","description":"Name server input data","properties":{"host":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Host","required":false},"ip":{"type":"ip","fullType":"ip","canBeNull":true,"readOnly":false,"description":"IP address","required":false}}},"domain.nameServer.NameServerStateEnum":{"id":"NameServerStateEnum","namespace":"domain.nameServer","description":"DNS server state","enum":["ko","ok"],"enumType":"string"},"domain.nameServer.NameServerStatus":{"id":"NameServerStatus","namespace":"domain.nameServer","description":"DNS server status","properties":{"state":{"type":"domain.nameServer.NameServerStateEnum","fullType":"domain.nameServer.NameServerStateEnum","canBeNull":false,"readOnly":true,"description":"Whether or not the DNS server is working","required":false},"type":{"type":"domain.nameServer.NameServerTypeEnum","fullType":"domain.nameServer.NameServerTypeEnum","canBeNull":false,"readOnly":true,"description":"Whether or not the DNS server is managed by OVHcloud","required":false},"usedSince":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Date from which the DNS server is used by the domain","required":false}}},"domain.nameServer.NameServerTypeEnum":{"id":"NameServerTypeEnum","namespace":"domain.nameServer","description":"DNS server type","enum":["anycast","dedicated","empty","external","hold","hosted","hosting","mixed","parking"],"enumType":"string"},"domain.nameServer.UpdatePayload":{"id":"UpdatePayload","namespace":"domain.nameServer","description":"Payload used to update the DNS of a domain name","properties":{"nameServers":{"type":"domain.nameServer.NameServerInput[]","fullType":"domain.nameServer.NameServerInput[]","canBeNull":false,"readOnly":false,"description":"Name servers to update","required":true}}},"domain.order.ContactOwner":{"id":"ContactOwner","namespace":"domain.order","description":"Owner contact reference for a domain order: an OVH contact resource, not a NIC handle.","properties":{"id":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Numeric identifier of the OVH contact resource (e.g. obtained from /me/contact). Distinct from a NIC handle such as xxxxx-ovh.","required":false}}},"domain.order.Contacts":{"id":"Contacts","namespace":"domain.order","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","fullType":"string","canBeNull":true,"readOnly":false,"description":"Administrative contact, given as an OVH NIC handle (e.g. xxxxx-ovh). Defaults to the calling customer's NIC if omitted.","required":false},"owner":{"type":"domain.order.ContactOwner","fullType":"domain.order.ContactOwner","canBeNull":true,"readOnly":false,"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.","required":false},"tech":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Technical contact, given as an OVH NIC handle (e.g. xxxxx-ovh). Defaults to the admin contact if omitted.","required":false}}},"domain.order.Contract":{"id":"Contract","namespace":"domain.order","description":"A contract (terms) the customer subscribes to when placing a domain order","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the contract (e.g. registration terms, general conditions of service)","required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to the contract terms document (PDF)","required":false}}},"domain.order.OrderRequest":{"id":"OrderRequest","namespace":"domain.order","description":"Payload to order a new domain name","properties":{"contacts":{"type":"domain.order.Contacts","fullType":"domain.order.Contacts","canBeNull":true,"readOnly":false,"description":"Admin, tech and owner contacts","required":false},"dns":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":false,"description":"List of DNS servers (hostnames) to set on the domain. Optional: if omitted, OVHcloud's recommended DNS servers for the domain are used.","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Fully-qualified domain name to order, including the extension (e.g. example.com)","required":true},"duration":{"type":"duration","fullType":"duration","canBeNull":true,"readOnly":false,"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.","required":false},"priceAcknowledge":{"type":"domain.order.PriceAcknowledge","fullType":"domain.order.PriceAcknowledge","canBeNull":true,"readOnly":false,"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.","required":false},"promoCodes":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":false,"description":"Promotion codes to apply. Optional.","required":false},"waiveRetractationPeriod":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Acknowledgment that the customer waives the legal retractation period. Must be set to true to place the order.","required":false},"zone":{"type":"domain.order.ZoneOptions","fullType":"domain.order.ZoneOptions","canBeNull":true,"readOnly":false,"description":"DNS zone options","required":false}}},"domain.order.OrderResponse":{"id":"OrderResponse","namespace":"domain.order","description":"Response returned after placing a domain order","properties":{"contacts":{"type":"domain.order.Contacts","fullType":"domain.order.Contacts","canBeNull":true,"readOnly":true,"description":"Contacts attached to the order","required":false},"contracts":{"type":"domain.order.Contract[]","fullType":"domain.order.Contract[]","canBeNull":true,"readOnly":true,"description":"Legal contracts (terms, as PDFs) the customer subscribes to with this order","required":false},"dns":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":true,"description":"DNS servers set on the domain","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Ordered domain name","required":false},"duration":{"type":"duration","fullType":"duration","canBeNull":false,"readOnly":true,"description":"Order duration in ISO-8601 format, whole years only (e.g. P1Y)","required":false},"orderId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Identifier of the created order, used with url to finalize and pay it","required":false},"pricing":{"type":"domain.order.Pricing","fullType":"domain.order.Pricing","canBeNull":false,"readOnly":true,"description":"Pricing breakdown of the order","required":false},"url":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Payment/finalization URL where the customer completes and pays the order","required":false},"zone":{"type":"domain.order.ZoneOptions","fullType":"domain.order.ZoneOptions","canBeNull":true,"readOnly":true,"description":"DNS zone options applied to the order","required":false}}},"domain.order.Price":{"id":"Price","namespace":"domain.order","description":"Price with its currency and textual representation as returned by domain/order","properties":{"currencyCode":{"type":"order.CurrencyCodeEnum","fullType":"order.CurrencyCodeEnum","canBeNull":false,"readOnly":true,"description":"Currency code","required":false},"text":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Human-readable price with currency, e.g. \"6.08 EUR\"","required":false},"value":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"The effective price as a number, e.g. 6.08","required":false}}},"domain.order.PriceAcknowledge":{"id":"PriceAcknowledge","namespace":"domain.order","description":"Minimal price payload sent by the client to acknowledge the price seen, before placing the actual order","properties":{"currencyCode":{"type":"order.CurrencyCodeEnum","fullType":"order.CurrencyCodeEnum","canBeNull":false,"readOnly":false,"description":"Currency code of the acknowledged price","required":true},"value":{"type":"double","fullType":"double","canBeNull":false,"readOnly":false,"description":"The effective price acknowledged by the client","required":true}}},"domain.order.Pricing":{"id":"Pricing","namespace":"domain.order","description":"Pricing breakdown with and without tax","properties":{"basePriceWithoutTax":{"type":"domain.order.Price","fullType":"domain.order.Price","canBeNull":false,"readOnly":true,"description":"Price excluding tax before any promotion","required":false},"discount":{"type":"domain.order.Price","fullType":"domain.order.Price","canBeNull":false,"readOnly":true,"description":"Total reduction applied by promotions, as a positive amount (0 if none)","required":false},"finalPriceWithTax":{"type":"domain.order.Price","fullType":"domain.order.Price","canBeNull":false,"readOnly":true,"description":"Final price including tax, after any reduction","required":false},"finalPriceWithoutTax":{"type":"domain.order.Price","fullType":"domain.order.Price","canBeNull":false,"readOnly":true,"description":"Final price excluding tax, after any reduction","required":false},"tax":{"type":"domain.order.Price","fullType":"domain.order.Price","canBeNull":false,"readOnly":true,"description":"Tax amount on the final price","required":false}}},"domain.order.ZoneOptions":{"id":"ZoneOptions","namespace":"domain.order","description":"DNS zone options for a domain order","properties":{"anycast":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Enable Anycast on the DNS zone. Applied only when a new zone is created (create=true and no existing zone); ignored otherwise.","required":false},"create":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Whether to create the DNS zone along with the domain. Defaults to true if omitted.","required":false},"dnssec":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"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.","required":false}}},"domain.rules.Optin":{"id":"Optin","namespace":"domain.rules","description":"Representation of the optin rule","properties":{"fields":{"type":"domain.OptinFieldsEnum[]","fullType":"domain.OptinFieldsEnum[]","canBeNull":false,"readOnly":true,"description":"Fields to display publicly on the Whois","required":false},"type":{"type":"domain.configurations.ContactTypeEnum","fullType":"domain.configurations.ContactTypeEnum","canBeNull":false,"readOnly":true,"description":"Type of the contact associated to the optin rule","required":false}}},"domain.zone.Capabilities":{"id":"Capabilities","namespace":"domain.zone","description":"DNS zone capabilities","properties":{"dynHost":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"True if dynHost available for this zone","required":false}}},"domain.zone.Dnssec":{"id":"Dnssec","namespace":"domain.zone","description":"DNS zone DNSSEC","properties":{"status":{"type":"domain.DnssecStatusEnum","fullType":"domain.DnssecStatusEnum","canBeNull":false,"readOnly":true,"description":"DNSSEC Status","required":false}}},"domain.zone.DynHostLogin":{"id":"DynHostLogin","namespace":"domain.zone","description":"Manage DynHost login","properties":{"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Subdomain that the login will be allowed to update (* to allow all)","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone","required":false}}},"domain.zone.DynHostRecord":{"id":"DynHostRecord","namespace":"domain.zone","description":"DynHost record","properties":{"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the DynHost record","required":false},"ip":{"type":"ip","fullType":"ip","canBeNull":false,"readOnly":false,"description":"Ip address of the DynHost record","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Subdomain of the DynHost record","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"DynHost record ttl","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone of the DynHost record","required":false}}},"domain.zone.Import":{"id":"Import","namespace":"domain.zone","description":"DNS zone import","properties":{"zoneFile":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Zone file that will be imported","required":true}}},"domain.zone.Option":{"id":"Option","namespace":"domain.zone","description":"DNS zone option","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The option name","required":false}}},"domain.zone.Record":{"id":"Record","namespace":"domain.zone","description":"DNS zone history","properties":{"fieldType":{"type":"domain.zone.RecordTypeEnum","fullType":"domain.zone.RecordTypeEnum","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the record","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Record subDomain","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Target of the record","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"TTL of the record","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Resource record zone","required":false}}},"domain.zone.RecordCreate":{"id":"RecordCreate","namespace":"domain.zone","description":"DNS zone history","properties":{"fieldType":{"type":"domain.zone.RecordTypeEnum","fullType":"domain.zone.RecordTypeEnum","canBeNull":false,"readOnly":false,"required":true},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the record","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Record subDomain","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Target of the record","required":true},"ttl":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"TTL of the record","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Resource record zone","required":false}}},"domain.zone.RecordTypeEnum":{"id":"RecordTypeEnum","namespace":"domain.zone","description":"Resource record name","enum":["A","AAAA","CAA","CNAME","DKIM","DMARC","DNAME","HTTPS","LOC","MX","NAPTR","NS","PTR","RP","SPF","SRV","SSHFP","SVCB","TLSA","TXT"],"enumType":"string"},"domain.zone.RecordUpdate":{"id":"RecordUpdate","namespace":"domain.zone","description":"DNS zone record","properties":{"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Record subdomain","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Target of the record","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"TTL of the record","required":false}}},"domain.zone.Redirection":{"id":"Redirection","namespace":"domain.zone","description":"DNS zone redirections","properties":{"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Description for the invisible redirection","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the redirection","required":false},"keywords":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Keywords for the invisible redirection","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Subdomain to redirect","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Target of the redirection","required":false},"title":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Title for the invisible redirection","required":false},"type":{"type":"domain.zone.RedirectionTypeEnum","fullType":"domain.zone.RedirectionTypeEnum","canBeNull":false,"readOnly":true,"required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Redirection zone","required":false}}},"domain.zone.RedirectionCreate":{"id":"RedirectionCreate","namespace":"domain.zone","description":"DNS zone redirection create","properties":{"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Description for the invisible redirection","required":false},"keywords":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Keywords for the invisible redirection","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Subdomain to redirect","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Target of the redirection","required":true},"title":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Title for the invisible redirection","required":false},"type":{"type":"domain.zone.RedirectionTypeEnum","fullType":"domain.zone.RedirectionTypeEnum","canBeNull":false,"readOnly":false,"required":true}}},"domain.zone.RedirectionTypeEnum":{"id":"RedirectionTypeEnum","namespace":"domain.zone","description":"Redirection type:\n - visible -> Redirection by http code 302\n - visiblePermanent -> Redirection by http code 301\n - invisible -> Redirection by html frame","enum":["invisible","visible","visiblePermanent"],"enumType":"string"},"domain.zone.RedirectionUpdate":{"id":"RedirectionUpdate","namespace":"domain.zone","description":"DNS zone redirection update","properties":{"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Description for the invisible redirection","required":false},"keywords":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Keywords for the invisible redirection","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Target of the redirection","required":false},"title":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Title for the invisible redirection","required":false},"type":{"type":"domain.zone.RedirectionTypeEnum","fullType":"domain.zone.RedirectionTypeEnum","canBeNull":false,"readOnly":false,"required":false}}},"domain.zone.Reset":{"id":"Reset","namespace":"domain.zone","description":"DNS zone reset","properties":{"DnsRecords":{"type":"domain.zone.ResetRecord[]","fullType":"domain.zone.ResetRecord[]","canBeNull":false,"readOnly":false,"description":"Records that will be set after reset","required":false},"minimized":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Create only mandatory records","required":false}}},"domain.zone.ResetRecord":{"id":"ResetRecord","namespace":"domain.zone","description":"Record associated to domain zone reset","properties":{"fieldType":{"type":"domain.zone.ResettableNamedResolutionFieldTypeEnum","fullType":"domain.zone.ResettableNamedResolutionFieldTypeEnum","canBeNull":false,"readOnly":false,"description":"Field type associated to domain zone reset","required":false},"target":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Target associated to domain zone reset","required":false}}},"domain.zone.ResettableNamedResolutionFieldTypeEnum":{"id":"ResettableNamedResolutionFieldTypeEnum","namespace":"domain.zone","description":"Resource record name","enum":["A","MX"],"enumType":"string"},"domain.zone.Soa":{"id":"Soa","namespace":"domain.zone","description":"DNS zone SOA","properties":{"email":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Email address of the DNS Administrator","required":false},"expire":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"When a zone transfer fails, a countdown clock begins. When the number of seconds set in the expire field elapses, the nameserver stops answering for that zone file","required":false},"nxDomainTtl":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"Non-Existent Domain TTL, if the name server returns a negative response, the remote server should wait the number of seconds set in the nxDomainTtl field before trying again","required":false},"refresh":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"The refresh value determines the interval in seconds between successful zone transfers of the entire zone file from a nameserver to another.","required":false},"serial":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"The serial number is used to indicate which copy of the zone file is the most current. When editing zone files, you must increment the serial number","required":false},"server":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Primary authoritative server","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"Time To Live in seconds","required":false}}},"domain.zone.Status":{"id":"Status","namespace":"domain.zone","description":"DNS zone status","properties":{"errors":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":true,"description":"Error list if any","required":false},"isDeployed":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the zone is deployed or not","required":false},"warnings":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":true,"description":"Warning list if any","required":false}}},"domain.zone.Task":{"id":"Task","namespace":"domain.zone","description":"DNS zone task","properties":{"canAccelerate":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can accelerate the task","required":false},"canCancel":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can cancel the task","required":false},"canRelaunch":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Can relaunch the task","required":false},"comment":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Comment about the task","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the task","required":false},"doneDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Done date of the task","required":false},"function":{"type":"domain.TaskFunctionEnum","fullType":"domain.TaskFunctionEnum","canBeNull":false,"readOnly":true,"description":"Function of the task","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the task","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Last update date of the task","required":false},"status":{"type":"domain.TaskStatusEnum","fullType":"domain.TaskStatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the task","required":false},"todoDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Todo date of the task","required":false}}},"domain.zone.Zone":{"id":"Zone","namespace":"domain.zone","description":"Zone dns Management","properties":{"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC supported by this zone","required":false},"hasDnsAnycast":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"hasDnsAnycast flag of the DNS zone","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date of the DNS zone","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone name","required":false},"nameServers":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Name servers that host the DNS zone","required":false}}},"domain.zone.ZoneRestorePoint":{"id":"ZoneRestorePoint","namespace":"domain.zone","description":"DNS zone history","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The date of backup creation","required":false},"zoneFileUrl":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The URL of the saved zone at this date","required":false}}},"domain.zone.ZoneWithIAM":{"id":"Zone","namespace":"domain.zone","description":"Zone dns Management","properties":{"dnssecSupported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is DNSSEC supported by this zone","required":false},"hasDnsAnycast":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"hasDnsAnycast flag of the DNS zone","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date of the DNS zone","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Zone name","required":false},"nameServers":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Name servers that host the DNS zone","required":false}}},"domain.zone.dynHost.Login":{"id":"Login","namespace":"domain.zone.dynHost","description":"DNS zone dynHost login","properties":{"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login name","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Login sub-domain","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login zone","required":false}}},"domain.zone.dynHost.LoginChangePassword":{"id":"LoginChangePassword","namespace":"domain.zone.dynHost","description":"DNS zone dynHost login password change","properties":{"password":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"New password of the DynHost login","required":true}}},"domain.zone.dynHost.LoginCreate":{"id":"LoginCreate","namespace":"domain.zone.dynHost","description":"DNS zone dynHost login creation","properties":{"loginSuffix":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Suffix that will be concatenated to the zoneName to create the login","required":true},"password":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"Password of the login","required":true},"subDomain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Subdomain that the login will be allowed to update (use * to allow all)","required":true}}},"domain.zone.dynHost.Record":{"id":"Record","namespace":"domain.zone.dynHost","description":"DNS zone dynHost record","properties":{"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Record ID","required":false},"ip":{"type":"ip","fullType":"ip","canBeNull":false,"readOnly":false,"description":"Record IP","required":false},"subDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Record sub-domain","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Record TTL (Time to Live)","required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Record zone","required":false}}},"iam.ResourceMetadata":{"id":"ResourceMetadata","namespace":"iam","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Resource display name","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Unique identifier of the resource","required":false},"state":{"type":"iam.ResourceMetadata.StateEnum","fullType":"iam.ResourceMetadata.StateEnum","canBeNull":true,"readOnly":true,"description":"Resource state","required":false},"tags":{"type":"map[string]string","fullType":"map[string]string","canBeNull":true,"readOnly":true,"description":"Resource tags. Tags that were internally computed are prefixed with ovh:","required":false},"urn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unique resource name used in policies","required":false}}},"iam.ResourceMetadata.StateEnum":{"id":"StateEnum","namespace":"iam.ResourceMetadata","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"],"enumType":"string"},"iam.resource.TagFilter":{"id":"TagFilter","namespace":"iam.resource","description":"Resource tag filter","properties":{"operator":{"type":"iam.resource.TagFilter.OperatorEnum","fullType":"iam.resource.TagFilter.OperatorEnum","canBeNull":true,"readOnly":true,"description":"Operator to use in order to filter on the value (defaults to 'EQ')","required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Value to use in order to filter tags","required":false}}},"iam.resource.TagFilter.OperatorEnum":{"id":"OperatorEnum","namespace":"iam.resource.TagFilter","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"],"enumType":"string"},"nichandle.CountryEnum":{"id":"CountryEnum","namespace":"nichandle","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"],"enumType":"string"},"nichandle.Currency":{"id":"Currency","namespace":"nichandle","description":"Customer currency","properties":{"code":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Currency code","required":false},"symbol":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Currency symbol","required":false}}},"nichandle.GenderEnum":{"id":"GenderEnum","namespace":"nichandle","description":"All genders a person can choose","enum":["female","male"],"enumType":"string"},"nichandle.LanguageEnum":{"id":"LanguageEnum","namespace":"nichandle","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"],"enumType":"string"},"nichandle.LegalFormEnum":{"id":"LegalFormEnum","namespace":"nichandle","description":"Legal forms a nichandle can be registered as","enum":["administration","association","corporation","individual","other","personalcorporation"],"enumType":"string"},"nichandle.Nichandle":{"id":"Nichandle","namespace":"nichandle","description":"Details about your OVH identifier","properties":{"address":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Address of nichandle","required":false},"area":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Area of nichandle","required":false},"birthCity":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"City of birth","required":false},"birthDay":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Birth date","required":false},"city":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"City of nichandle","required":false},"companyNationalIdentificationNumber":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Company National Identification Number","required":false},"complementaryAddress":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Complementary Address","required":false},"corporationType":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Corporation type","required":false},"country":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":false,"readOnly":false,"description":"Customer country","required":false},"currency":{"type":"nichandle.Currency","fullType":"nichandle.Currency","canBeNull":false,"readOnly":true,"description":"Customer currency","required":false},"customerCode":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Your customer code (a numerical value used for identification when contacting support via phone call)","required":false},"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Display name shown instead of the organisation name.","required":false},"einvoicingBillingAddress":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Default e-invoicing billing address","required":false},"email":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Email address","required":false},"fax":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Fax number","required":false},"firstname":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"First name","required":false},"italianSDI":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Italian SDI","required":false},"kycValidated":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"KYC validation state","required":false},"language":{"type":"nichandle.LanguageEnum","fullType":"nichandle.LanguageEnum","canBeNull":true,"readOnly":false,"description":"Language","required":false},"legalform":{"type":"nichandle.LegalFormEnum","fullType":"nichandle.LegalFormEnum","canBeNull":false,"readOnly":false,"description":"Customer legal form","required":false},"name":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Customer name","required":false},"nationalIdentificationNumber":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"National Identification Number","required":false},"nichandle":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Customer identifier","required":false},"organisation":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Name of organisation","required":false},"ovhCompany":{"type":"nichandle.OvhCompanyEnum","fullType":"nichandle.OvhCompanyEnum","canBeNull":false,"readOnly":true,"description":"OVH company","required":false},"ovhSubsidiary":{"type":"nichandle.OvhSubsidiaryEnum","fullType":"nichandle.OvhSubsidiaryEnum","canBeNull":false,"readOnly":true,"description":"OVH subsidiary","required":false},"phone":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Phone number","required":false},"phoneCountry":{"type":"nichandle.CountryEnum","fullType":"nichandle.CountryEnum","canBeNull":true,"readOnly":false,"required":false},"phoneType":{"type":"nichandle.PhoneTypeEnum","fullType":"nichandle.PhoneTypeEnum","canBeNull":true,"readOnly":false,"description":"Type of phone(mobile, landline)","required":false},"purposeOfPurchase":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Customer purpose of purchase","required":false},"sex":{"type":"nichandle.GenderEnum","fullType":"nichandle.GenderEnum","canBeNull":true,"readOnly":false,"description":"Gender","required":false},"spareEmail":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Spare email","required":false},"state":{"type":"nichandle.StateEnum","fullType":"nichandle.StateEnum","canBeNull":false,"readOnly":true,"description":"Nichandle state","required":false},"vat":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"VAT number","required":false},"zip":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Zipcode","required":false}}},"nichandle.OvhCompanyEnum":{"id":"OvhCompanyEnum","namespace":"nichandle","description":"OVH companies","enum":["kimsufi","ovh","soyoustart"],"enumType":"string"},"nichandle.OvhSubsidiaryEnum":{"id":"OvhSubsidiaryEnum","namespace":"nichandle","description":"OVH subsidiaries","enum":["CZ","DE","ES","EU","FI","FR","GB","IE","IT","LT","MA","NL","PL","PT","SN","TN"],"enumType":"string"},"nichandle.PhoneTypeEnum":{"id":"PhoneTypeEnum","namespace":"nichandle","description":"All phone type a person can choose","enum":["landline","mobile"],"enumType":"string"},"nichandle.StateEnum":{"id":"StateEnum","namespace":"nichandle","description":"States a nichandle can be in","enum":["complete","incomplete"],"enumType":"string"},"order.CurrencyCodeEnum":{"id":"CurrencyCodeEnum","namespace":"order","description":"Currency code","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"],"enumType":"string"},"service.RenewType":{"id":"RenewType","namespace":"service","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service is automatically renewed","required":false},"deleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service will be deleted at expiration","required":false},"forced":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service forced to be renewed","required":false},"manualPayment":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"The service needs to be manually renewed and paid","required":false},"period":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"period of renew in month","required":false}}},"service.RenewalTypeEnum":{"id":"RenewalTypeEnum","namespace":"service","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","manual","oneShot","option"],"enumType":"string"},"service.StateEnum":{"id":"StateEnum","namespace":"service","description":"service.StateEnum","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"],"enumType":"string"},"service.TerminationFutureUseEnum":{"id":"TerminationFutureUseEnum","namespace":"service","description":"All future uses you can provide for a service termination","enum":["NOT_REPLACING_SERVICE","OTHER","SUBSCRIBE_AN_OTHER_SERVICE","SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR","SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"],"enumType":"string"},"service.TerminationReasonEnum":{"id":"TerminationReasonEnum","namespace":"service","description":"All reasons you can provide for a service termination","enum":["FEATURES_DONT_SUIT_ME","LACK_OF_PERFORMANCES","MIGRATED_TO_ANOTHER_OVH_PRODUCT","MIGRATED_TO_COMPETITOR","NOT_ENOUGH_RECOGNITION","NOT_NEEDED_ANYMORE","NOT_RELIABLE","NO_ANSWER","OTHER","PRODUCT_DIMENSION_DONT_SUIT_ME","PRODUCT_TOOLS_DONT_SUIT_ME","TOO_EXPENSIVE","TOO_HARD_TO_USE","UNSATIFIED_BY_CUSTOMER_SUPPORT"],"enumType":"string"},"services.Service":{"id":"Service","namespace":"services","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Indicates that the service can be set up to be deleted at expiration","required":false},"contactAdmin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactBilling":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactTech":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"creation":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"engagedUpTo":{"type":"date","fullType":"date","canBeNull":true,"readOnly":true,"required":false},"expiration":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"possibleRenewPeriod":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"All the possible renew period of your service in month","required":false},"renew":{"type":"service.RenewType","fullType":"service.RenewType","canBeNull":true,"readOnly":false,"description":"Way of handling the renew","required":false},"renewalType":{"type":"service.RenewalTypeEnum","fullType":"service.RenewalTypeEnum","canBeNull":false,"readOnly":true,"required":false},"serviceId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"service.StateEnum","fullType":"service.StateEnum","canBeNull":false,"readOnly":true,"required":false}}},"services.changeContact":{"id":"changeContact","namespace":"services","description":"Service change contact payload","properties":{"contactAdmin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as admin contact","required":false},"contactBilling":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as billing contact","required":false},"contactTech":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as tech contact","required":false}}},"services.confirmTermination":{"id":"confirmTermination","namespace":"services","description":"Service confirm termination payload","properties":{"commentary":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your termination request","required":false},"commentaryFutureUse":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your future use","required":false},"commentaryReason":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your reason for termination request","required":false},"futureUse":{"type":"service.TerminationFutureUseEnum","fullType":"service.TerminationFutureUseEnum","canBeNull":false,"readOnly":false,"description":"All future uses you can provide for a service termination","required":false},"reason":{"type":"service.TerminationReasonEnum","fullType":"service.TerminationReasonEnum","canBeNull":false,"readOnly":false,"description":"All reasons you can provide for a service termination","required":false},"token":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The termination token sent by email to the admin contact","required":true}}},"zone.Capabilities":{"id":"Capabilities","namespace":"zone","description":"Zone capabilities","properties":{"dynHost":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"True if dynHost available for this zone","required":false}}},"zone.NamedResolutionFieldTypeEnum":{"id":"NamedResolutionFieldTypeEnum","namespace":"zone","description":"Resource record fieldType","enum":["A","AAAA","CAA","CNAME","DKIM","DMARC","DNAME","LOC","MX","NAPTR","NS","PTR","SPF","SRV","SSHFP","TLSA","TXT"],"enumType":"string"},"zone.RedirectionTypeEnum":{"id":"RedirectionTypeEnum","namespace":"zone","description":"Redirection type enum : visible -> Redirection by http code 302, visiblePermanent -> Redirection by http code 301, invisible -> Redirection by html frame","enum":["invisible","visible","visiblePermanent"],"enumType":"string"},"zone.ResetRecord":{"id":"ResetRecord","namespace":"zone","description":"Resource record","properties":{"fieldType":{"type":"zone.ResettableNamedResolutionFieldTypeEnum","canBeNull":false,"readOnly":false,"required":false},"target":{"type":"string","canBeNull":false,"readOnly":false,"description":"Resource record target","required":false}}},"zone.ResettableNamedResolutionFieldTypeEnum":{"id":"ResettableNamedResolutionFieldTypeEnum","namespace":"zone","description":"Resource record type","enum":["A","MX"],"enumType":"string"},"zone.Status":{"id":"Status","namespace":"zone","description":"Zone status","properties":{"errors":{"type":"string[]","canBeNull":true,"readOnly":false,"description":"Error list","required":false},"isDeployed":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"True if the zone has successfully been deployed","required":false},"warnings":{"type":"string[]","canBeNull":true,"readOnly":false,"description":"Warning list","required":false}}}}}