{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"common.TaskProgress":{"type":"object","description":"Detailed information about an asynchronous operation progress steps","properties":{"name":{"type":"string","description":"Progress step name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current status of the progress step","readOnly":true}}},"common.TaskStatusEnum":{"type":"string","description":"Current status of a task","enum":["DONE","ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"domain.task.AdditionalDetails":{"type":"object","description":"Additional details for a domain name task","properties":{"dnssec":{"allOf":[{"$ref":"#/components/schemas/domain.task.additionalDetails.DnssecTransferStatus"}],"description":"DNSSEC-related transfer analysis details","nullable":true,"readOnly":true},"dnssecRiskAcknowledged":{"type":"boolean","description":"Set to true to accept the DNSSEC risk and proceed with the transfer","nullable":true},"estimatedCompletionAt":{"type":"string","description":"Estimated date when the task will complete","nullable":true,"format":"date-time","readOnly":true}}},"domain.task.DomainTask":{"type":"object","description":"Domain-specific task with additional transfer details","properties":{"additionalDetails":{"allOf":[{"$ref":"#/components/schemas/domain.task.AdditionalDetails"}],"description":"Operation-specific details, present for certain task types like DomainIncomingTransfer","nullable":true,"readOnly":true},"createdAt":{"type":"string","description":"Creation date of the task","format":"date-time","readOnly":true},"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"finishedAt":{"type":"string","description":"Ending date of the task","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"string","description":"Unique identifier of the task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the related resource","readOnly":true},"message":{"type":"string","description":"Description of the task","readOnly":true},"progress":{"type":"array","description":"Progress steps of the asynchronous operation","items":{"$ref":"#/components/schemas/common.TaskProgress"},"readOnly":true},"startedAt":{"type":"string","description":"Starting date of the task","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current global status of the task","readOnly":true},"type":{"type":"string","description":"Type of the task","readOnly":true},"updatedAt":{"type":"string","description":"Last update of the task","format":"date-time","readOnly":true}}},"domain.task.TaskTypeEnum":{"type":"string","description":"Public task types (operation names) that can be returned for a domain name resource","enum":["ContactControl","ContactControlAcknowledge","ContactControlCorrect","ContactControlNotify","DomainAfterMarket","DomainContactControl","DomainContactUpdate","DomainCreate","DomainDelete","DomainDnsUpdate","DomainDsUpdate","DomainEmailRedirectionsCreate","DomainEmailRedirectionsDelete","DomainHold","DomainHostCreate","DomainHostDelete","DomainHostUpdate","DomainIncomingTransfer","DomainOutgoingTransfer","DomainProtect","DomainRegistryDelete","DomainRenew","DomainResourceDelete","DomainRestore","DomainTrade","DomainUnhold","DomainUnprotect"]},"domain.task.additionalDetails.DnssecTransferStatus":{"type":"object","description":"DNSSEC transfer analysis performed during an incoming transfer","properties":{"decision":{"allOf":[{"$ref":"#/components/schemas/domain.task.additionalDetails.dnssecTransferStatus.Decision"}],"description":"Decision taken regarding DNSSEC handling during the transfer","nullable":true,"readOnly":true},"preTransfer":{"allOf":[{"$ref":"#/components/schemas/domain.task.additionalDetails.dnssecTransferStatus.PreTransfer"}],"description":"DNSSEC status detected before the transfer","nullable":true,"readOnly":true},"registry":{"allOf":[{"$ref":"#/components/schemas/domain.task.additionalDetails.dnssecTransferStatus.Registry"}],"description":"Registry capability information regarding DNSSEC","nullable":true,"readOnly":true}}},"domain.task.additionalDetails.dnssecTransferStatus.Decision":{"type":"object","description":"Decision taken regarding DNSSEC handling during the transfer","properties":{"autoHandling":{"type":"boolean","description":"Whether DNSSEC handling is performed automatically","readOnly":true},"preserveDnssec":{"type":"boolean","description":"Whether DNSSEC records will be preserved after transfer","readOnly":true},"reason":{"type":"string","description":"Human-readable explanation of the decision","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/domain.task.additionalDetails.dnssecTransferStatus.DecisionStatusEnum"}],"description":"Status of the DNSSEC transfer decision","readOnly":true},"synchronizeDnsRecords":{"type":"boolean","description":"Whether DNS records will be synchronized after transfer","readOnly":true}}},"domain.task.additionalDetails.dnssecTransferStatus.DecisionStatusEnum":{"type":"string","description":"Status of the DNSSEC transfer decision","enum":["BLOCKED","PROCEED"]},"domain.task.additionalDetails.dnssecTransferStatus.PreTransfer":{"type":"object","description":"DNSSEC status detected on the domain before the transfer","properties":{"dnskeyCount":{"type":"integer","description":"Number of DNSKEY records found","readOnly":true},"dsCount":{"type":"integer","description":"Number of DS records found","readOnly":true},"hadDnssec":{"type":"boolean","description":"Whether the domain had active DNSSEC before transfer","readOnly":true},"hasDnskey":{"type":"boolean","description":"Whether the domain had DNSKEY records","readOnly":true}}},"domain.task.additionalDetails.dnssecTransferStatus.Registry":{"type":"object","description":"Registry capability information regarding DNSSEC","properties":{"supportsDnssec":{"type":"boolean","description":"Whether the registry supports DNSSEC","readOnly":true}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/domain/name/{domainName}/task":{"get":{"operationId":"getAllDomainNameTasks","summary":"List tasks related to a managed domain name resource","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the tasks by status","schema":{"$ref":"#/components/schemas/common.TaskStatusEnum"}},{"in":"query","name":"type","description":"Filter the tasks by type (operation name, for example DomainTrade, DomainContactUpdate)","schema":{"$ref":"#/components/schemas/domain.task.TaskTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/domain.task.DomainTask"}},"examples":{"List tasks":{"value":[{"additionalDetails":null,"createdAt":"2024-03-20T08:58:29.32968Z","errors":null,"finishedAt":null,"id":"045a727b-c79d-4225-8d95-65c5fdb86063","link":"v2/domain/name/example.fr/task/045a727b-c79d-4225-8d95-65c5fdb86063","message":"Schedule DomainUnlock operation","progress":[],"startedAt":null,"status":"PENDING","type":"DomainUnprotect","updatedAt":"2024-03-20T08:58:29.32968Z"},{"additionalDetails":{"dnssec":{"decision":{"autoHandling":false,"preserveDnssec":false,"reason":"OVH DNS selected, no active DNSSEC. Can enable DNSSEC later via Manager.","status":"PROCEED","synchronizeDnsRecords":false},"preTransfer":{"dnskeyCount":0,"dsCount":0,"hadDnssec":false,"hasDnskey":false},"registry":{"supportsDnssec":false}},"estimatedCompletionAt":"2026-05-12T08:19:06Z"},"createdAt":"2026-05-04T10:18:23+02:00","errors":null,"finishedAt":null,"id":"23c198c4-4033-450e-bbe8-322d7f560955","link":"v2/domain/name/example.fr/task/23c198c4-4033-450e-bbe8-322d7f560955","message":"DomainIncomingTransfer operation","progress":[{"name":"Task pending","status":"PENDING"}],"startedAt":"2026-05-04T10:18:23+02:00","status":"SCHEDULED","type":"DomainIncomingTransfer","updatedAt":"2026-05-04T10:19:06+02:00"}],"summary":"Response body returned when listing domain name tasks"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Tasks@@@10"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/domain/name/{domainName}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/domain/name/{domainName}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/task/get","required":true}],"x-response-identifier":"id","x-expanded-response":"DomainTaskDomainTask"}},"/domain/name/{domainName}/task/{taskId}":{"get":{"operationId":"getDomainNameTask","summary":"Get a specific task related to a managed domain name resource","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.task.DomainTask"},"examples":{"Get a simple task":{"value":{"additionalDetails":null,"createdAt":"2024-03-20T08:58:29.32968Z","errors":null,"finishedAt":null,"id":"045a727b-c79d-4225-8d95-65c5fdb86063","link":"v2/domain/name/example.fr/task/045a727b-c79d-4225-8d95-65c5fdb86063","message":"Schedule DomainUnlock operation","progress":[],"startedAt":null,"status":"PENDING","type":"DomainUnprotect","updatedAt":"2024-03-20T08:58:29.32968Z"},"summary":"Retrieve a task without additional details"},"Get an incoming transfer task with DNSSEC details":{"value":{"additionalDetails":{"dnssec":{"decision":{"autoHandling":false,"preserveDnssec":false,"reason":"OVH DNS selected, no active DNSSEC. Can enable DNSSEC later via Manager.","status":"PROCEED","synchronizeDnsRecords":false},"preTransfer":{"dnskeyCount":0,"dsCount":0,"hadDnssec":false,"hasDnskey":false},"registry":{"supportsDnssec":false}},"estimatedCompletionAt":"2026-05-12T08:19:06Z"},"createdAt":"2026-05-04T10:18:23+02:00","errors":null,"finishedAt":null,"id":"23c198c4-4033-450e-bbe8-322d7f560955","link":"v2/domain/name/example.fr/task/23c198c4-4033-450e-bbe8-322d7f560955","message":"DomainIncomingTransfer operation","progress":[{"name":"Task pending","status":"PENDING"}],"startedAt":"2026-05-04T10:18:23+02:00","status":"SCHEDULED","type":"DomainIncomingTransfer","updatedAt":"2026-05-04T10:19:06+02:00"},"summary":"Retrieve a DomainIncomingTransfer task with additional DNSSEC analysis"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Tasks@@@20"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/domain/name/{domainName}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/domain/name/{domainName}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/task/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editDomainNameTask","summary":"Update a domain name task with additional details","description":"Provide additional details on a task to unblock its processing.\n\n## Acknowledge DNSSEC risk\n\nWhen an incoming transfer is blocked due to a DNSSEC risk, set `dnssecRiskAcknowledged` to `true` to accept the risk and proceed with the transfer. When omitted or set to `false`, no action is taken.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.task.AdditionalDetails"},"examples":{"Acknowledge DNSSEC risk on a blocked transfer":{"value":{"dnssecRiskAcknowledged":true},"summary":"Set dnssecRiskAcknowledged to true to proceed with the transfer"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.task.DomainTask"},"examples":{"Task updated after DNSSEC risk acknowledgment":{"value":{"additionalDetails":{"dnssec":{"decision":{"autoHandling":false,"preserveDnssec":true,"reason":"DNSSEC risk acknowledged by customer.","status":"PROCEED","synchronizeDnsRecords":false},"preTransfer":{"dnskeyCount":2,"dsCount":2,"hadDnssec":true,"hasDnskey":true},"registry":{"supportsDnssec":true}},"estimatedCompletionAt":"2024-03-27T08:58:29Z"},"createdAt":"2024-03-20T08:58:29.32968Z","errors":null,"finishedAt":null,"id":"18647459-b260-4000-8b85-55c315152903","link":"v2/domain/name/example.com/task/18647459-b260-4000-8b85-55c315152903","message":"DNSSEC risk acknowledged","progress":[],"startedAt":"2024-03-20T08:58:29.32968Z","status":"SCHEDULED","type":"DomainIncomingTransfer","updatedAt":"2024-03-20T09:00:00.32968Z"},"summary":"The transfer resumes after acknowledging the DNSSEC risk"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Domains","Tasks@@@30"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: domain.task.AdditionalDetails\nresult = client.put(\"/v2/domain/name/{domainName}/task/{taskId}\",\n\tdnssecRiskAcknowledged = None, # Set to true to accept the DNSSEC risk and proceed with the transfer (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: domain.task.AdditionalDetails\n$result = $ovh->put(\"/v2/domain/name/{domainName}/task/{taskId}\", array(\n\tdnssecRiskAcknowledged => null, // Set to true to accept the DNSSEC risk and proceed with the transfer (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"domain:apiovh:name/task/edit","required":true}]}}}}