{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"domain.DomainMlLanguageEnum":{"type":"string","description":"Possible values for mailing list language","enum":["de","en","es","fr","it","nl","pl","pt"]},"domain.DomainSpecialAccountActionEnum":{"type":"string","description":"Possible values for pop action task","enum":["add","change","delete"]},"domain.DomainSpecialAccountTypeEnum":{"type":"string","description":"Possible type task","enum":["25g","alias","delete","filter","forward","responder"]},"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.domain.TaskMl":{"type":"object","description":"Task Mailing List","properties":{"account":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"date":{"type":"string","format":"date-time","readOnly":true},"domain":{"type":"string","readOnly":true},"id":{"type":"integer","readOnly":true},"language":{"allOf":[{"$ref":"#/components/schemas/domain.DomainMlLanguageEnum"}],"readOnly":true}}},"email.domain.TaskSpecialAccount":{"type":"object","description":"Task special account List","properties":{"account":{"type":"string","description":"Account name of task","readOnly":true},"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountActionEnum"}],"description":"Action of task","readOnly":true},"date":{"type":"string","description":"Creation date of task","format":"date-time","readOnly":true},"domain":{"type":"string","description":"Domain name of task","readOnly":true},"id":{"type":"string","description":"Id of task","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountTypeEnum"}],"description":"Type of action filter","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/domain/{domain}/task/mailinglist":{"get":{"summary":"List mailing list tasks","description":"List mailing list tasks. Returns the IDs of the pending mailing list tasks of the domain. Filter them by `account`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"account","description":"Account name","schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Tasks@@@70"],["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@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/domain/{domain}/task/mailinglist\")\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/domain/{domain}/task/mailinglist\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:task/mailinglist/get","required":true}],"x-expanded-response":"EmailDomainTaskMl"}},"/email/domain/{domain}/task/mailinglist/{id}":{"get":{"summary":"Get a mailing list task","description":"Get a mailing list task. Returns the action, the account, the domain, the language and the creation date of the mailing list task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskMl"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Tasks@@@80"],["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@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/domain/{domain}/task/mailinglist/{id}\")\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/domain/{domain}/task/mailinglist/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:task/mailinglist/get","required":true}]}},"/email/domain/{domain}/task/redirection":{"get":{"summary":"List redirection tasks","description":"Returns the IDs of the pending redirection tasks of the domain. Filter them by `account`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"account","description":"Account name","schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","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","Roundcube platform","Tasks@@@90"],["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@30"]],"x-badges":[{"color":"blue","label":"Alpha 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/domain/{domain}/task/redirection\")\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/domain/{domain}/task/redirection\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:task/redirection/get","required":true}],"x-expanded-response":"EmailDomainTaskSpecialAccount"}},"/email/domain/{domain}/task/redirection/{id}":{"get":{"summary":"Get a redirection task","description":"Returns the account, type, action and creation date of the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskSpecialAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Tasks@@@100"],["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@40"]],"x-badges":[{"color":"blue","label":"Alpha 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/domain/{domain}/task/redirection/{id}\")\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/domain/{domain}/task/redirection/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:task/redirection/get","required":true}]}},"/email/mxplan/{service}/account/{email}/task":{"get":{"summary":"List email account tasks","description":"List email account tasks. Returns the IDs of the tasks of the email account. Get one to follow its function, status and dates.","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":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/account/{email}/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(\"/email/mxplan/{service}/account/{email}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/task/get","required":true}],"x-expanded-response":"EmailProTask"}},"/email/mxplan/{service}/account/{email}/task/{id}":{"get":{"summary":"Get a task","description":"Get a task. Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Task id","required":true,"schema":{"type":"integer"}},{"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","Tasks@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/account/{email}/task/{id}\")\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}/task/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:account/task/get","required":true}]}},"/email/mxplan/{service}/task":{"get":{"summary":"List service tasks","description":"List service tasks. Returns the IDs of the tasks of the MX Plan service. Get one to follow its function, status and dates.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"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":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Zimbra platform","Tasks@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/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(\"/email/mxplan/{service}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:task/get","required":true}],"x-expanded-response":"EmailProTask"}},"/email/mxplan/{service}/task/{id}":{"get":{"summary":"Get a task","description":"Get a task. Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Task id","required":true,"schema":{"type":"integer"}},{"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","Tasks@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/mxplan/{service}/task/{id}\")\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}/task/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailMxplan:apiovh:task/get","required":true}]}}}}