General Information
All operations require authentication.
List Exchange organizationsProduction
List Exchange organizations. Returns the names of the Exchange organizations of the account. Each organization holds one or more services.
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
List Exchange servicesProduction
List Exchange services. Returns the names of the Exchange services of the organization. Filter them by IAM tags with iamTags.
Path parameters
The internal name of your exchange organization
Query parameters
Filter resources on IAM tags
Response
Example uses organizationName = string
$ curl https:/[ "string"]
Get the Exchange serviceProduction
Get the Exchange service. Returns the offer, state, hostname, display name, password and lockout policy, message size limits, spam and virus settings and SSL expiration date of the service.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Enable or disable password change via ADFS
DNS Domain Control Validation record, require for order ssl varification process
enable policy for strong and secure passwords
ID of the authentication policy to apply on a new Exchange account
Relay domain address that can be used to send all e-mails via default send connector
service displayName
IAM resource metadata
Update date
number of minutes account will remain locked if it occurs
number of minutes that must elapse after a failed logon to reset lockout trigger
number of attempts before account to be locked
maximum number of days that account's password is valid before expiration
Maximum message size that You can receive in MB
Maximum message size that You can send in MB
minimum number of days before able to change account's password
minimum number of characters password must contain
Service Offer name
dedicateddedicatedClusterhostedprovidernumber of historical password that cannot be reused
Spam and Antivirus configuration
Exchange Service State
inMaintenanceoksuspendedTask pending id
URL for web interface
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "adfsChangePassword": true, "cnameDcvRecord": "string", "complexityEnabled": true, "defaultAuthenticationPolicyId": 0, "defaultSmartHost": "string", "displayName": "string", "domain": "string", "hostname": "string", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "lastUpdateDate": "2024-01-01T12:00:00Z", "lockoutDuration": 0, "lockoutObservationWindow": 0, "lockoutThreshold": 0, "maxPasswordAge": 0, "maxReceiveSize": 0, "maxSendSize": 0, "minPasswordAge": 0, "minPasswordLength": 0, "offer": "dedicated", "passwordHistoryCount": 0, "spamAndVirusConfiguration": { "checkDKIM": true, "checkSPF": true, "deleteSpam": true, "deleteVirus": true, "putInJunk": true, "tagSpam": true, "tagVirus": true }, "sslExpirationDate": "2024-01-01", "state": "inMaintenance", "taskPendingId": 0, "webUrl": "string"}
Update the Exchange serviceProduction
Update the Exchange service. Updates the display name, password and lockout policy, message size limits, spam and virus settings, ADFS password change and default authentication policy of the service.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Enable or disable password change via ADFS
DNS Domain Control Validation record, require for order ssl varification process
enable policy for strong and secure passwords
ID of the authentication policy to apply on a new Exchange account
Relay domain address that can be used to send all e-mails via default send connector
service displayName
Update date
number of minutes account will remain locked if it occurs
number of minutes that must elapse after a failed logon to reset lockout trigger
number of attempts before account to be locked
maximum number of days that account's password is valid before expiration
Maximum message size that You can receive in MB
Maximum message size that You can send in MB
minimum number of days before able to change account's password
minimum number of characters password must contain
Service Offer name
dedicateddedicatedClusterhostedprovidernumber of historical password that cannot be reused
Spam and Antivirus configuration
Exchange Service State
inMaintenanceoksuspendedTask pending id
URL for web interface
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/Change the SSL hostnameProduction
Change the SSL hostname. Sets the SSL hostname of the service and returns the task. Validate the hostname with a DCV email (dcvEmail) or a CNAME record (useCname); useDnsAssist sets the DNS records for a domain managed by OVHcloud.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Email address used for Domain Control Validation, one of the options for ownership validation
FQDN of SSL hostname
Use CNAME for Domain Control Validation, one of the options for ownership validation
Set required Exchange DNS fields automatically if the hostname domain is managed by OVH
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
List DCV emailsProduction
List DCV emails. Returns the email addresses that can receive the domain control validation email, when the SSL certificate expires within 30 days.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ "string"]
List active licensesProduction
List active licenses. Returns, for each day, the number of active accounts per license and the number of Outlook licenses. Filter by fromDate, toDate or license.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Query parameters
Get active licenses since date
License type
basicenterprisestandardGet active licenses until date
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ { "accountLicense": [ { "license": "basic", "licenseQuantity": 0 } ], "date": "2024-01-01", "outlookQuantity": 0 }]
List available Outlook versionsProduction
List available Outlook versions. Returns whether each Outlook version and language is available. Filter by outlookVersion or outlookLanguage.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Query parameters
Language version of outlook
arbgczdadeelenesetfifrhehrhuidinitjakokzltlvmsnbnlplptpt-BRrorsruskslsvthtrukvizh-CNOS version of outlook
mac_x86_2016mac_x86_2019mac_x86_2021windows_x64_2016windows_x64_2019windows_x64_2021windows_x86_2016windows_x86_2019windows_x86_2021Response
Outlook language
arbgczdadeelenesetfifrhehrhuidinitjakokzltlvmsnbnlplptpt-BRrorsruskslsvthtrukvizh-CNOutlook version
mac_x86_2016mac_x86_2019mac_x86_2021windows_x64_2016windows_x64_2019windows_x64_2021windows_x86_2016windows_x86_2019windows_x86_2021Example uses exchangeService = string, organizationName = string
$ curl https:/[ { "outlookLanguage": "ar", "outlookVersion": "mac_x86_2016", "status": true }]
Renew the SSL certificateProduction
Renew the SSL certificate. Renews the SSL certificate when it expires within 30 days, and returns the task. Validate the domain with a DCV email (dcv) or a CNAME record (useCname), which useDnsAssist creates for a domain managed by OVHcloud.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
DCV email require for order ssl varification process, one of the options for ownership validation
Use CNAME for Domain Control Validation, one of the options for ownership validation
Set required CNAME record automatically if the domain is managed by OVH
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Get the serverProduction
Get the server. Returns the Exchange version, state, IP addresses, disk usage, DNS record checks and Outlook Web Access MFA status of the server.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Exchange commercial version
2010201320162019SECurrent disk usage in MB
Total disk size in MB
If true server is 2010 individual offer
ipV4
ipV6
If true your dns A record is valid
If true your dns AAAA record is valid
If true your dns ptrV6 record is valid
If true your dns ptr record is valid
Indicates if Multi Factor Authentication is activated on Outlook Web Access interface
Server state
configurationErrorconfigurationPendingnotConfiguredokTask pending id
ExchangeServer version
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "commercialVersion": "2010", "currentDiskUsage": 0, "diskSize": 0, "individual2010": true, "ip": "string", "ipV6": "string", "isAValid": true, "isAaaaValid": true, "isPtrV6Valid": true, "isPtrValid": true, "owaMfa": true, "state": "configurationError", "taskPendingId": 0, "version": 0}
Update the serverProduction
Update the server. Updates the server settings: set owaMfa to enable or disable MFA on the Outlook Web Access interface.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Exchange commercial version
2010201320162019SECurrent disk usage in MB
Total disk size in MB
If true server is 2010 individual offer
ipV4
ipV6
If true your dns A record is valid
If true your dns AAAA record is valid
If true your dns ptrV6 record is valid
If true your dns ptr record is valid
Indicates if Multi Factor Authentication is activated on Outlook Web Access interface
Server state
configurationErrorconfigurationPendingnotConfiguredokTask pending id
ExchangeServer version
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses exchangeService = string, organizationName = string
$ curl https:/{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
Update service informationProduction
Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidResponse
Example uses exchangeService = string, organizationName = string
$ curl https:/List Active Directory servicesProduction
List Active Directory services. Returns the names of the Active Directory services of the account. Filter them by IAM tags with iamTags.
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
Get an Active Directory serviceProduction
Get an Active Directory service. Returns the name, state and password policy of the Active Directory service, and the service name of the linked Microsoft 365 tenant.
Path parameters
The internal name of your Active Directory organization
Response
Flag indicating if passwords should be forced to follow Microsoft's password guidelines
IAM resource metadata
Account lock time (in minutes) when too much passwords have been tried
Time (in minutes) before the password attempts counter is reset
Maximum number of password tries before account locking
Maximum lifespan of passwords, in days
Minimum lifespan of passwords, in days (0 = unlimited)
Minimum number of characters passwords must contain
Name of the Active Directory organizational unit
Service name of the office tenant (/licence/office/{serviceName}) linked to this AD service
Current state of the Active Directory organizational unit
creatingdeletinginMaintenanceokreopeningsuspendedsuspendingTask pending id
Example uses serviceName = string
$ curl https:/{ "complexityEnabled": true, "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "lockoutDuration": 0, "lockoutObservationWindow": 0, "lockoutThreshold": 0, "maxPasswordAge": 0, "minPasswordAge": 0, "minPasswordLength": 0, "name": "string", "officeTenantServiceName": "string", "state": "creating", "taskPendingId": 0}
Update an Active Directory serviceProduction
Update an Active Directory service. Updates the password policy: complexity, minimum length, minimum and maximum age, and lockout threshold, duration and observation window.
Path parameters
The internal name of your Active Directory organization
Request body (required)
Flag indicating if passwords should be forced to follow Microsoft's password guidelines
Account lock time (in minutes) when too much passwords have been tried
Time (in minutes) before the password attempts counter is reset
Maximum number of password tries before account locking
Maximum lifespan of passwords, in days
Minimum lifespan of passwords, in days (0 = unlimited)
Minimum number of characters passwords must contain
Name of the Active Directory organizational unit
Service name of the office tenant (/licence/office/{serviceName}) linked to this AD service
Current state of the Active Directory organizational unit
creatingdeletinginMaintenanceokreopeningsuspendedsuspendingTask pending id
Response
Example uses serviceName = string
$ curl https:/Change service contactsProduction
Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
Path parameters
The internal name of your Active Directory organization
Request body (required)
The contact to set as admin contact
The contact to set as billing contact
The contact to set as tech contact
Response
Example uses serviceName = string
$ curl https:/[ 0]
Get the linked Exchange serviceProduction
Get the linked Exchange service. Returns the Exchange service linked to the Active Directory service: offer, hostname, state, SSL certificate expiration date, message size limits and spam and antivirus configuration.
Path parameters
The internal name of your Active Directory organization
Response
Service family name displayed
Exchange service name
Exchange service URL
Maximum allowable size for received messages in MB
Maximum allowable size of sent messages in MB
Exchange service offer
dedicateddedicatedClusterhostedproviderSpam and Antivirus configuration
Expiration date of SSL certificate
Exchange service state
creatingdeletinginMaintenanceokreopeningsuspendedsuspendingTask pending id
Example uses serviceName = string
$ curl https:/{ "displayName": "string", "domain": "string", "hostname": "string", "maxReceiveSize": 0, "maxSendSize": 0, "offer": "dedicated", "spamAndVirusConfiguration": { "checkDKIM": true, "checkSPF": true, "deleteSpam": true, "deleteVirus": true, "putInJunk": true, "tagSpam": true, "tagVirus": true }, "sslExpirationDate": "2024-01-01", "state": "creating", "taskPendingId": 0}
Update the linked Exchange serviceProduction
Update the linked Exchange service. Updates the display name, the maximum sizes of sent and received messages in MB, and the spam and antivirus configuration of the Exchange service.
Path parameters
The internal name of your Active Directory organization
Request body (required)
Service family name displayed
Exchange service name
Exchange service URL
Maximum allowable size for received messages in MB
Maximum allowable size of sent messages in MB
Exchange service offer
dedicateddedicatedClusterhostedproviderSpam and Antivirus configuration
Expiration date of SSL certificate
Exchange service state
creatingdeletinginMaintenanceokreopeningsuspendedsuspendingTask pending id
Response
Example uses serviceName = string
$ curl https:/Check the billing migrationProduction
Check the billing migration. Returns true when the service is billed by the new OVHcloud billing system.
Path parameters
The internal name of your Active Directory organization
Response
Example uses serviceName = string
$ curl https:/true