Skip to content
Console(the OVHcloud Console, opens in a new tab)

Domains

All operations require authentication.

5 operationsv2/zimbra/platform
OpenAPI
Agent setup

List domainsProduction

GET
/v2/zimbra/platform/{platformId}/domain

Returns the domains of the platform with their current state. Filter them by organizationId, organizationLabel or domainName.

Path parameters

platformId
required
stringuuid

Platform ID

Query parameters

domainName
string

Filter by domain name

organizationId
stringuuid

Filter by organization identifier

organizationLabel
string

Filter by organization label

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200DomainResponse[]successful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
DomainCurrentState

Object representing domain

currentTasks
read-only
CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

id
read-only
stringuuid

Resource identifier in UUID representation

resourceStatus
read-only
ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
DomainResponseTargetSpec

Object representing domain

404objectError 404 response

Example uses platformId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/domain \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "checksum": "string",    "currentState": {      "accountsStatistics": [        {          "availableAccountsCount": 0,          "configuredAccountsCount": 0,          "offer": "PRO"        }      ],      "createdAt": "2024-01-01T12:00:00Z",      "expectedDNSConfig": {        "autodiscover": "string",        "dkim": {          "cnames": [            {              "name": null,              "value": null            }          ]        },        "mx": [          {            "priority": 0,            "target": "string"          }        ],        "ownership": {          "cname": "string"        },        "spf": "string"      },      "name": "string",      "organizationId": "00000000-0000-0000-0000-000000000000",      "organizationLabel": "string",      "status": "READY",      "updatedAt": "2024-01-01T12:00:00Z"    },    "currentTasks": [      {        "errors": [          {            "message": "string"          }        ],        "id": "00000000-0000-0000-0000-000000000000",        "link": "string",        "status": "ERROR",        "type": "string"      }    ],    "id": "00000000-0000-0000-0000-000000000000",    "resourceStatus": "CREATING",    "targetSpec": {      "dkimEnabled": true,      "organizationId": "00000000-0000-0000-0000-000000000000"    }  }]

Get a domainProduction

GET
/v2/zimbra/platform/{platformId}/domain/{domainId}

Returns the domain, its organization, its account statistics per offer and the DNS configuration to apply: ownership, MX, SPF, DKIM and autodiscover.

Path parameters

domainId
required
stringuuid

Domain ID

platformId
required
stringuuid

Platform ID

Response

200DomainResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
DomainCurrentState

Object representing domain

currentTasks
read-only
CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

id
read-only
stringuuid

Resource identifier in UUID representation

resourceStatus
read-only
ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
DomainResponseTargetSpec

Object representing domain

404objectError 404 response

Example uses domainId = 00000000-0000-0000-0000-000000000000, platformId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/domain/{domainId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "expectedDNSConfig": {      "autodiscover": "string",      "dkim": {        "cnames": [          {            "name": "string",            "value": "string"          }        ]      },      "mx": [        {          "priority": 0,          "target": "string"        }      ],      "ownership": {        "cname": "string"      },      "spf": "string"    },    "name": "string",    "organizationId": "00000000-0000-0000-0000-000000000000",    "organizationLabel": "string",    "status": "READY",    "updatedAt": "2024-01-01T12:00:00Z"  },  "currentTasks": [    {      "errors": [        {          "message": "string"        }      ],      "id": "00000000-0000-0000-0000-000000000000",      "link": "string",      "status": "ERROR",      "type": "string"    }  ],  "id": "00000000-0000-0000-0000-000000000000",  "resourceStatus": "CREATING",  "targetSpec": {    "dkimEnabled": true,    "organizationId": "00000000-0000-0000-0000-000000000000"  }}

Create a domainProduction

POST
/v2/zimbra/platform/{platformId}/domain

Adds a domain to an organization from its name and organizationId. When the DNS zone is hosted by OVHcloud, autoConfigureMX, autoConfigureSPF, autoConfigureDKIM and autoConfigureAutodiscover configure the matching records automatically. Creation is asynchronous: follow resourceStatus and currentTasks.

Path parameters

platformId
required
stringuuid

Platform ID

Request body (required)

targetSpec
required
DomainPostTargetSpec

Target organization specification

Response

200DomainResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
DomainCurrentState

Object representing domain

currentTasks
read-only
CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

id
read-only
stringuuid

Resource identifier in UUID representation

resourceStatus
read-only
ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
DomainResponseTargetSpec

Object representing domain

400objectError 400 response
404objectError 404 response

Example uses platformId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/domain \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "expectedDNSConfig": {      "autodiscover": "string",      "dkim": {        "cnames": [          {            "name": "string",            "value": "string"          }        ]      },      "mx": [        {          "priority": 0,          "target": "string"        }      ],      "ownership": {        "cname": "string"      },      "spf": "string"    },    "name": "string",    "organizationId": "00000000-0000-0000-0000-000000000000",    "organizationLabel": "string",    "status": "READY",    "updatedAt": "2024-01-01T12:00:00Z"  },  "currentTasks": [    {      "errors": [        {          "message": "string"        }      ],      "id": "00000000-0000-0000-0000-000000000000",      "link": "string",      "status": "ERROR",      "type": "string"    }  ],  "id": "00000000-0000-0000-0000-000000000000",  "resourceStatus": "CREATING",  "targetSpec": {    "dkimEnabled": true,    "organizationId": "00000000-0000-0000-0000-000000000000"  }}

Delete a domainProduction

DELETE
/v2/zimbra/platform/{platformId}/domain/{domainId}

Deletes the domain from its organization.

Path parameters

domainId
required
stringuuid

Domain ID

platformId
required
stringuuid

Platform ID

Response

200—successful operation

Example uses domainId = 00000000-0000-0000-0000-000000000000, platformId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/domain/{domainId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a domainProduction

PUT
/v2/zimbra/platform/{platformId}/domain/{domainId}

Enables or disables DKIM with dkimEnabled, or moves the domain, with its email accounts, to another organization with organizationId. When set, checksum must match the current checksum of the domain, otherwise the update is rejected.

Path parameters

domainId
required
stringuuid

Domain ID

platformId
required
stringuuid

Platform ID

Request body (required)

checksum
string

Known checksum of the resource, allowing to prevent unwanted side effects

targetSpec
required
DomainPutTargetSpec

Target domain specification

Response

200DomainResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
DomainCurrentState

Object representing domain

currentTasks
read-only
CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

id
read-only
stringuuid

Resource identifier in UUID representation

resourceStatus
read-only
ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
DomainResponseTargetSpec

Object representing domain

404objectError 404 response
412objectError 412 response

Example uses domainId = 00000000-0000-0000-0000-000000000000, platformId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/domain/{domainId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "expectedDNSConfig": {      "autodiscover": "string",      "dkim": {        "cnames": [          {            "name": "string",            "value": "string"          }        ]      },      "mx": [        {          "priority": 0,          "target": "string"        }      ],      "ownership": {        "cname": "string"      },      "spf": "string"    },    "name": "string",    "organizationId": "00000000-0000-0000-0000-000000000000",    "organizationLabel": "string",    "status": "READY",    "updatedAt": "2024-01-01T12:00:00Z"  },  "currentTasks": [    {      "errors": [        {          "message": "string"        }      ],      "id": "00000000-0000-0000-0000-000000000000",      "link": "string",      "status": "ERROR",      "type": "string"    }  ],  "id": "00000000-0000-0000-0000-000000000000",  "resourceStatus": "CREATING",  "targetSpec": {    "dkimEnabled": true,    "organizationId": "00000000-0000-0000-0000-000000000000"  }}