{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"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"},"email.mxplan.AccountAlias":{"type":"object","description":"Aliases on this mailbox","properties":{"alias":{"type":"string","description":"Alias","readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"taskPendingId":{"type":"integer","description":"Pending task id","readOnly":true}}},"email.pro.Task":{"type":"object","description":"Organization task details","properties":{"finishDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/email.pro.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"Task id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/email.pro.TaskStatusEnum"}],"description":"Task status","readOnly":true},"todoDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true}}},"email.pro.TaskFunctionEnum":{"type":"string","description":"function enumeration for task","enum":["addAccount","addAlias","addDomain","addDomainDKIM","addDomainDisclaimer","addExternalContact","addFullAccess","addSendAs","addSendOnBehalfTo","addServiceAuthorizedIp","changeHostname","changePassword","configureCustomer","deleteAccount","deleteAlias","deleteDomain","deleteDomainDKIM","deleteDomainDisclaimer","deleteExternalContact","deleteFullAccess","deleteSendAs","deleteSendOnBehalfTo","deleteService","deleteServiceAuthorizedIp","diagnoseAccount","disableDKIM","enableDKIM","expandDrive","installServer","maintenance","migrateAccountViaOMM","migrationAccount","migrationDisclaimer","migrationExternalContact","migrationHistory","migrationService","reOpenAccount","setAccount","setAlias","setDns","setDomain","setDomainDisclaimer","setExternalContact","setService","suspendAccount","suspendService","unknown","unsuspendAccount","unsuspendService"]},"email.pro.TaskStatusEnum":{"type":"string","description":"Task status","enum":["cancelled","doing","done","error","todo"]},"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":{"/email/mxplan/{service}/account/{email}/alias":{"get":{"summary":"List account aliases","description":"List account aliases. Returns the aliases of the email account: extra addresses that deliver to the same mailbox.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}},{"in":"path","name":"service","description":"The internal name of your mxplan organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Aliases@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/account/{email}/alias\")\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(\"/email/mxplan/{service}/account/{email}/alias\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/alias/get","required":true}],"x-expanded-response":"EmailMxplanAccountAlias"},"post":{"summary":"Create an account alias","description":"Create an account alias. Adds the `alias` address to the email account, so that it receives its emails, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}},{"in":"path","name":"service","description":"The internal name of your mxplan organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"type":"string","description":"Alias"}},"required":["alias"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.pro.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Aliases@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/email/mxplan/{service}/account/{email}/alias\",\n\talias = None, # Alias (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/email/mxplan/{service}/account/{email}/alias\", array(\n\talias => null, // Alias (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/alias/create","required":true}]}},"/email/mxplan/{service}/account/{email}/alias/{alias}":{"delete":{"summary":"Delete an account alias","description":"Delete an account alias. Removes the alias address from the email account, which no longer receives its emails, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"alias","description":"Alias","required":true,"schema":{"type":"string"}},{"in":"path","name":"email","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}},{"in":"path","name":"service","description":"The internal name of your mxplan organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.pro.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Aliases@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/mxplan/{service}/account/{email}/alias/{alias}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/mxplan/{service}/account/{email}/alias/{alias}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/alias/delete","required":true}]},"get":{"summary":"Get an account alias","description":"Get an account alias. Returns the alias address, its creation date and the ID of its pending task, if any (`taskPendingId`).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"alias","description":"Alias","required":true,"schema":{"type":"string"}},{"in":"path","name":"email","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}},{"in":"path","name":"service","description":"The internal name of your mxplan organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.mxplan.AccountAlias"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Aliases@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/account/{email}/alias/{alias}\")\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(\"/email/mxplan/{service}/account/{email}/alias/{alias}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/alias/get","required":true}]}}}}