{"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.DomainPopActionEnum":{"type":"string","description":"Possible values for pop action task","enum":["addAccount","changeAccount","changePassword","deleteAccount","internalMigration","migration","temporaryTask","unknown"]},"domain.DomainUsageAccountStruct":{"type":"object","description":"Structure of usage account","properties":{"date":{"type":"string","description":"Timestamp","nullable":true,"format":"date-time"},"emailCount":{"type":"integer","description":"Number of message in mailbox","nullable":true},"quota":{"type":"integer","description":"Size of mailbox (bytes)","nullable":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"},"email.domain.Account":{"type":"object","description":"Account List","properties":{"accountName":{"type":"string","description":"Name of account","readOnly":true},"description":{"type":"string","description":"Account description"},"domain":{"type":"string","description":"Name of domain","readOnly":true},"email":{"type":"string","description":"Email","readOnly":true},"isBlocked":{"type":"boolean","description":"If true your account is blocked","readOnly":true},"size":{"type":"integer","description":"Size of your account in bytes"}}},"email.domain.Delegation":{"type":"object","description":"Delegation List","properties":{"accountId":{"type":"string","description":"OVH customer unique identifier","readOnly":true}}},"email.domain.MigrationAccount":{"type":"object","description":"Migration account","properties":{"destinationEmailAddress":{"type":"string","description":"Destination account name","readOnly":true},"quota":{"type":"integer","description":"Account maximum size","readOnly":true}}},"email.domain.MigrationCheckCodeEnum":{"type":"string","description":"Result code of check migration","enum":["ACCOUNT_EMPTY","ACCOUNT_INPROGRESS","DELEGATION_EXIST","DOMAIN_EMPTY","FILTER_EXIST","FORWARD_EXIST","FORWARD_LOCAL","MAILINGLIST_EXIST","MAILINGLIST_INPROGRESS","MAILPROXY_BAD_INFRA","MAILPROXY_EMPTY","MAILPROXY_INPROGRESS","MAILPROXY_RESERVATION","REDIRECTION_INPROGRESS","RESPONDER_EXIST","RESPONDER_INPROGRESS","UNKNOW"]},"email.domain.MigrationCheckResultStruct":{"type":"object","description":"Check Migration result","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/email.domain.MigrationCheckCodeEnum"}],"description":"Result code of check migration"},"details":{"type":"string","description":"Details of result code","nullable":true}}},"email.domain.MigrationCheckStruct":{"type":"object","description":"Check Migration result","properties":{"alias":{"type":"array","description":"List of aliases","nullable":true,"items":{"type":"string"}},"error":{"type":"array","description":"List of errors","nullable":true,"items":{"$ref":"#/components/schemas/email.domain.MigrationCheckResultStruct"}},"filter":{"type":"array","description":"List of filters","nullable":true,"items":{"type":"string"}},"forward":{"type":"array","description":"List of forwards","nullable":true,"items":{"type":"string"}},"warning":{"type":"array","description":"List of warnings","nullable":true,"items":{"$ref":"#/components/schemas/email.domain.MigrationCheckResultStruct"}}}},"email.domain.MigrationService":{"type":"object","description":"Migration service","properties":{"contactAdmin":{"type":"string","description":"Admin contact of service","readOnly":true},"contactBilling":{"type":"string","description":"Billing contact of service","readOnly":true},"contactTech":{"type":"string","description":"Tech contact of service","readOnly":true},"creation":{"type":"string","description":"Creation date of service","format":"date","readOnly":true},"destinationServiceName":{"type":"string","description":"Service name allowed as migration destination","readOnly":true},"expiration":{"type":"string","description":"Expiration date of service","format":"date","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/email.domain.MigrationServiceType"}],"description":"Offer type of service","readOnly":true}}},"email.domain.MigrationServiceType":{"type":"string","description":"Types of migration service","enum":["EMAIL PRO","HOSTED EXCHANGE","PRIVATE EXCHANGE","PROVIDER EXCHANGE"]},"email.domain.TaskPop":{"type":"object","description":"Task Pop List","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainPopActionEnum"}],"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":"integer","description":"Id of task","readOnly":true},"name":{"type":"string","description":"Account name of task","readOnly":true}}},"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}/account":{"get":{"summary":"List email accounts","description":"List email accounts. Returns the names of the email accounts of the domain. Filter them by `accountName` or `description`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"accountName","description":"Account name","schema":{"type":"string"}},{"in":"query","name":"description","description":"Account description","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","Accounts@@@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}/account\")\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}/account\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/get","required":true}],"x-expanded-response":"EmailDomainAccount"},"post":{"summary":"Create an email account","description":"Create an email account. Creates an email account with a name, a password, and optionally a description and a size in bytes, and returns the task. The size is 5 GB by default; the allowed sizes are in `allowedAccountSize` of the email domain. The password needs 8 to 30 characters and no accents.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Account name"},"description":{"type":"string","description":"Description Account"},"password":{"type":"string","description":"Account password","format":"password"},"size":{"type":"integer","description":"Account size in bytes (default : 5000000000) (possible values : /email/domain/{domain}/allowedAccountSize )"}},"required":["accountName","password"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskPop"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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\nresult = client.post(\"/email/domain/{domain}/account\",\n\taccountName = None, # Account name (type: string)\n\tdescription = None, # Description Account (type: string, nullable)\n\tpassword = None, # Account password (type: password)\n\tsize = None, # Account size in bytes (default : 5000000000) (possible values : /email/domain/{domain}/allowedAccountSize ) (type: long, 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$result = $ovh->post(\"/email/domain/{domain}/account\", array(\n\taccountName => null, // Account name (type: string)\n\tdescription => null, // Description Account (type: string, nullable)\n\tpassword => null, // Account password (type: password)\n\tsize => null, // Account size in bytes (default : 5000000000) (possible values : /email/domain/{domain}/allowedAccountSize ) (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/create","required":true}]}},"/email/domain/{domain}/account/{accountName}":{"delete":{"summary":"Delete an email account","description":"Delete an email account. Deletes the email account of the domain and returns the task. Follow it under `task/account/{id}`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"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":{"$ref":"#/components/schemas/email.domain.TaskPop"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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/domain/{domain}/account/{accountName}\")\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/domain/{domain}/account/{accountName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/delete","required":true}]},"get":{"summary":"Get an email account","description":"Get an email account. Returns the email address, description, size in bytes and blocked state of the email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"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":{"$ref":"#/components/schemas/email.domain.Account"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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}/account/{accountName}\")\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}/account/{accountName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/get","required":true}]},"put":{"summary":"Update an email account","description":"Update an email account. Updates the description or the size in bytes of the email account. The allowed sizes are in `allowedAccountSize` of the email domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.Account"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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\n# Request body type: email.domain.Account\nresult = client.put(\"/email/domain/{domain}/account/{accountName}\",\n\tdescription = None, # Account description (type: string)\n\tsize = None, # Size of your account in bytes (type: integer)\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: email.domain.Account\n$result = $ovh->put(\"/email/domain/{domain}/account/{accountName}\", array(\n\tdescription => null, // Account description (type: string)\n\tsize => null, // Size of your account in bytes (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/edit","required":true}]}},"/email/domain/{domain}/account/{accountName}/changePassword":{"post":{"summary":"Change an email account password","description":"Change an email account password. Sets a new password and returns the task. The password needs 8 to 30 characters and no accents.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password","format":"password"}},"required":["password"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskPop"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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\n# Request body type: password\nresult = client.post(\"/email/domain/{domain}/account/{accountName}/changePassword\",\n\tpassword = None, # New password (type: password)\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: password\n$result = $ovh->post(\"/email/domain/{domain}/account/{accountName}/changePassword\", array(\n\tpassword => null, // New password (type: password)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/changePassword","required":true}]}},"/email/domain/{domain}/account/{accountName}/delegation":{"get":{"summary":"List delegations","description":"List delegations. Returns the OVHcloud account IDs (`accountId`) that have been delegated the management of the email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"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","Accounts@@@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/domain/{domain}/account/{accountName}/delegation\")\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}/account/{accountName}/delegation\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/delegation/get","required":true}],"x-expanded-response":"EmailDomainDelegation"},"post":{"summary":"Create a delegation","description":"Create a delegation. Gives the OVHcloud account `accountId` the management of the email account, from its own control panel.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string","description":"OVH customer unique identifier"}},"required":["accountId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@90"]],"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: coreTypes.AccountId:string\nresult = client.post(\"/email/domain/{domain}/account/{accountName}/delegation\",\n\taccountId = None, # OVH customer unique identifier (type: coreTypes.AccountId: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: coreTypes.AccountId:string\n$result = $ovh->post(\"/email/domain/{domain}/account/{accountName}/delegation\", array(\n\taccountId => null, // OVH customer unique identifier (type: coreTypes.AccountId:string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/delegation/create","required":true}]}},"/email/domain/{domain}/account/{accountName}/delegation/{accountId}":{"delete":{"summary":"Remove a delegation","description":"Remove a delegation. Withdraws from the OVHcloud account the management of the email account that it had been delegated.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountId","description":"OVH customer unique identifier","required":true,"schema":{"type":"string"}},{"in":"path","name":"accountName","description":"Name of account","required":true,"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":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@100"]],"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/domain/{domain}/account/{accountName}/delegation/{accountId}\")\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/domain/{domain}/account/{accountName}/delegation/{accountId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/delegation/delete","required":true}]},"get":{"summary":"Get a delegation","description":"Get a delegation. Returns the OVHcloud account ID (`accountId`) that has been delegated the management of the email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountId","description":"OVH customer unique identifier","required":true,"schema":{"type":"string"}},{"in":"path","name":"accountName","description":"Name of account","required":true,"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":{"$ref":"#/components/schemas/email.domain.Delegation"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@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/domain/{domain}/account/{accountName}/delegation/{accountId}\")\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}/account/{accountName}/delegation/{accountId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/delegation/get","required":true}]}},"/email/domain/{domain}/account/{accountName}/migrate":{"get":{"summary":"List migration destinations","description":"List migration destinations. Returns the names of the services the email account can be migrated to. Filter them by `type`: Email Pro, hosted, private or provider Exchange.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Type of migration service","schema":{"$ref":"#/components/schemas/email.domain.MigrationServiceType"}}],"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","Accounts@@@110"]],"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(\"/email/domain/{domain}/account/{accountName}/migrate\")\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}/account/{accountName}/migrate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/get","required":true}],"x-expanded-response":"EmailDomainMigrationService"}},"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}":{"get":{"summary":"Get a migration destination","description":"Get a migration destination. Returns the offer type, creation and expiration dates, and admin, tech and billing contacts of the destination service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationServiceName","description":"Service name allowed as migration destination","required":true,"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":{"$ref":"#/components/schemas/email.domain.MigrationService"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@120"]],"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(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}\")\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}/account/{accountName}/migrate/{destinationServiceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/get","required":true}]}},"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress":{"get":{"summary":"List destination email accounts","description":"List destination email accounts. Returns the email addresses of the destination service the email account can be migrated to. Filter them by minimum size with `quota`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationServiceName","description":"Service name allowed as migration destination","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}},{"in":"query","name":"quota","description":"Account maximum size","schema":{"type":"integer"}}],"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","Accounts@@@130"]],"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(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress\")\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}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/destinationEmailAddress/get","required":true}],"x-expanded-response":"EmailDomainMigrationAccount"}},"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}":{"get":{"summary":"Get a destination email account","description":"Get a destination email account. Returns the email address and maximum size of the destination account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationEmailAddress","description":"Destination account name","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationServiceName","description":"Service name allowed as migration destination","required":true,"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":{"$ref":"#/components/schemas/email.domain.MigrationAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@140"]],"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(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}\")\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}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/destinationEmailAddress/get","required":true}]}},"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/checkMigrate":{"get":{"summary":"Check an email account migration","description":"Check an email account migration. Returns the errors and warnings found for the migration to the destination account, and the aliases, filters and forwards found.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationEmailAddress","description":"Destination account name","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationServiceName","description":"Service name allowed as migration destination","required":true,"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":{"$ref":"#/components/schemas/email.domain.MigrationCheckStruct"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@150"]],"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(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/checkMigrate\")\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}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/checkMigrate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/destinationEmailAddress/checkMigrate/get","required":true}]}},"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/migrate":{"post":{"summary":"Migrate an email account","description":"Migrate an email account. Migrates the email account to the destination account and returns the task. `password` is the new password used for the migration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationEmailAddress","description":"Destination account name","required":true,"schema":{"type":"string"}},{"in":"path","name":"destinationServiceName","description":"Service name allowed as migration destination","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password used for migration","format":"password"}},"required":["password"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskPop"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@160"]],"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: password\nresult = client.post(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/migrate\",\n\tpassword = None, # New password used for migration (type: password)\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: password\n$result = $ovh->post(\"/email/domain/{domain}/account/{accountName}/migrate/{destinationServiceName}/destinationEmailAddress/{destinationEmailAddress}/migrate\", array(\n\tpassword => null, // New password used for migration (type: password)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/migrate/destinationEmailAddress/migrate","required":true}]}},"/email/domain/{domain}/account/{accountName}/updateUsage":{"post":{"summary":"Refresh email account usage","description":"Refresh email account usage. Asks for the figures returned by `usage` to be recomputed; they are updated asynchronously.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@170"]],"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.post(\"/email/domain/{domain}/account/{accountName}/updateUsage\")\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->post(\"/email/domain/{domain}/account/{accountName}/updateUsage\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/updateUsage","required":true}]}},"/email/domain/{domain}/account/{accountName}/usage":{"get":{"summary":"Get email account usage","description":"Get email account usage. Returns the number of emails, the maximum size in bytes of the mailbox (`quota`) and the date of the measure.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"accountName","description":"Name of account","required":true,"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":{"$ref":"#/components/schemas/domain.DomainUsageAccountStruct"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Accounts@@@180"]],"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}/account/{accountName}/usage\")\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}/account/{accountName}/usage\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:account/usage/get","required":true}]}}}}