{"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.exchange.DeviceActiveSyncStateEnum":{"type":"string","description":"Device ActiveSync state","enum":["allowed","blocked","deviceDiscovery","quarantined"]},"email.exchange.Task":{"type":"object","description":"Exchange task details","properties":{"finishDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"Task id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskStatusEnum"}],"description":"Task status","readOnly":true},"todoDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true}}},"email.exchange.TaskFunctionEnum":{"type":"string","description":"function enumeration for exchange task","enum":["activateSharepoint","addAccount","addAccountArchive","addAccountImpersonation","addActiveSyncMailNotification","addAlias","addDistributionGroup","addDistributionGroupManager","addDistributionGroupMember","addDistributionGroupSendAs","addDistributionGroupSendOnBehalfTo","addDomain","addDomainDisclaimer","addExchangeCustomIsolation","addExchangeDomainDKIM","addExchangeRemoteMailbox","addExchangeServiceAuthorizedIp","addExportPstRequest","addExternalContact","addFullAccess","addOutlookLicense","addPublicFolder","addPublicFolderPermission","addResourceAccount","addResourceDelegate","addSendAs","addSendConnector","addSendOnBehalfTo","addSharedAccount","addSharedAccountFullAccess","addSharedAccountSendAs","addSharedAccountSendOnBehalfTo","changeHostname","changePassword","clearDataOnDevice","cloneTemplateExchangePrivate","configureExchangeCustomer","configureExchangeOwaMfa","copyMailbox","createExternalAntiSpamReceiveConnector","deleteAccount","deleteAccountArchive","deleteAccountImpersonation","deleteActiveSyncMailNotification","deleteAlias","deleteDistributionGroup","deleteDistributionGroupManager","deleteDistributionGroupMember","deleteDistributionGroupSendAs","deleteDistributionGroupSendOnBehalfTo","deleteDomain","deleteDomainDisclaimer","deleteExchangeCustomIsolation","deleteExchangeDomainDKIM","deleteExchangeRemoteMailbox","deleteExchangeService","deleteExchangeServiceAuthorizedIp","deleteExportPstRequest","deleteExternalAntiSpamReceiveConnector","deleteExternalContact","deleteFullAccess","deleteOutlookLicense","deletePublicFolder","deletePublicFolderPermission","deleteResourceAccount","deleteResourceDelegate","deleteSendAs","deleteSendConnector","deleteSendOnBehalfTo","deleteSharedAccount","deleteSharedAccountFullAccess","deleteSharedAccountSendAs","deleteSharedAccountSendOnBehalfTo","destroyPrivateVm","diagnoseAccount","disableExchangeDKIM","enableExchangeDKIM","expandDrive","generateOutlookUrl","generatePstUrl","installExchange","installSSL","maintenance","migrationAccount","migrationDisclaimer","migrationExternalContact","migrationHistory","migrationMailingList","migrationResourceAccount","migrationService","reOpenHostedAccount","reOpenOutlookLicense","reOpenPrivateAccount","reOpenPrivateVm","setAccount","setAccountArchive","setAlias","setDistributionGroup","setDns","setDomain","setDomainDisclaimer","setExchangeAccountProtocol","setExchangeRemoteMailbox","setExchangeServiceDevice","setExternalAntiSpamReceiveConnector","setExternalContact","setPublicFolder","setPublicFolderPermission","setResourceAccount","setSendConnector","setService","setSharedAccount","suspendAccount","suspendExchangeService","suspendHostedAccount","suspendOutlookLicense","suspendPrivateAccount","suspendPrivateVm","unsuspendAccount","unsuspendExchangeService","unsuspendHostedAccount","updateExchangeServiceDevice","upgrade2016"]},"email.exchange.TaskStatusEnum":{"type":"string","description":"Exchange task status","enum":["cancelled","doing","done","error","todo"]},"email.exchange.exchangeServiceDevice":{"type":"object","description":"Get the list of your ActiveSync devices registered on this Exchange service","properties":{"IMEI":{"type":"string","description":"International Mobile Equipment Identity","readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"deviceId":{"type":"string","description":"Device Id","readOnly":true},"deviceModel":{"type":"string","description":"Model device","readOnly":true},"deviceState":{"allOf":[{"$ref":"#/components/schemas/email.exchange.DeviceActiveSyncStateEnum"}],"description":"Device State"},"guid":{"type":"string","description":"user guid","readOnly":true},"identity":{"type":"string","description":"Exchange identity","readOnly":true},"lastUpdate":{"type":"string","description":"Last update date","nullable":true,"format":"date-time","readOnly":true},"taskPendingId":{"type":"integer","description":"Pending task id","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/exchange/{organizationName}/service/{exchangeService}/device":{"get":{"summary":"List devices","description":"List devices. Returns the identities of the ActiveSync devices registered on the service. Filter them by `identity`, `IMEI` or `deviceState`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"IMEI","description":"Filter the value of IMEI property (like)","schema":{"type":"string"}},{"in":"query","name":"deviceState","description":"Filter the value of deviceState property (=)","schema":{"$ref":"#/components/schemas/email.exchange.DeviceActiveSyncStateEnum"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"query","name":"identity","description":"Filter the value of identity property (like)","schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange 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","Microsoft Exchange","Hosted Exchange","Devices@@@10"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Devices@@@10"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Devices@@@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/exchange/{organizationName}/service/{exchangeService}/device\")\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/exchange/{organizationName}/service/{exchangeService}/device\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/device/get","required":true}],"x-expanded-response":"EmailExchangeExchangeServiceDevice"}},"/email/exchange/{organizationName}/service/{exchangeService}/device/{identity}":{"get":{"summary":"Get a device","description":"Get a device. Returns the model, IMEI, device ID, ActiveSync state and last update date of the ActiveSync device.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","description":"Exchange identity","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.exchangeServiceDevice"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Devices@@@20"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Devices@@@20"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Devices@@@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/exchange/{organizationName}/service/{exchangeService}/device/{identity}\")\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/exchange/{organizationName}/service/{exchangeService}/device/{identity}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/device/get","required":true}]},"put":{"summary":"Update a device","description":"Update a device. Updates the ActiveSync state of the device with `deviceState`, for example to allow, block or quarantine it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","description":"Exchange identity","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.exchangeServiceDevice"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Devices@@@30"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Devices@@@30"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Devices@@@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: email.exchange.exchangeServiceDevice\nresult = client.put(\"/email/exchange/{organizationName}/service/{exchangeService}/device/{identity}\",\n\tdeviceState = None, # Device State (type: email.exchange.DeviceActiveSyncStateEnum)\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.exchange.exchangeServiceDevice\n$result = $ovh->put(\"/email/exchange/{organizationName}/service/{exchangeService}/device/{identity}\", array(\n\tdeviceState => null, // Device State (type: email.exchange.DeviceActiveSyncStateEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/device/edit","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/device/{identity}/clearDevice":{"post":{"summary":"Reset a device to factory settings","description":"Reset a device to factory settings. Runs a factory reset on the device and returns the task. This cannot be undone: all data on the device is lost.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","description":"Exchange identity","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Devices@@@40"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Devices@@@40"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Devices@@@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.post(\"/email/exchange/{organizationName}/service/{exchangeService}/device/{identity}/clearDevice\")\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/exchange/{organizationName}/service/{exchangeService}/device/{identity}/clearDevice\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/device/clearDevice","required":true}]}}}}