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

Organizations

All operations require authentication.

5 operationsv2/zimbra/platform
OpenAPI
Agent setup

List organizationsProduction

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

Returns the organizations of the platform with their current state. Filter them by organizationName.

Path parameters

platformId
required
stringuuid

Platform ID

Query parameters

organizationName
string

Filter by organization name

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200OrganizationResponse[]successful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
OrganizationCurrentState

Object representing organization

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
OrganizationPutTargetSpec

Object representing organization

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/organization \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "checksum": "string",    "currentState": {      "accountsStatistics": [        {          "availableAccountsCount": 0,          "configuredAccountsCount": 0,          "offer": "PRO"        }      ],      "createdAt": "2024-01-01T12:00:00Z",      "description": "string",      "label": "string",      "name": "string",      "storageConsumed": 0,      "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": {      "description": "string",      "label": "string",      "name": "string"    }  }]

Get an organizationProduction

GET
/v2/zimbra/platform/{platformId}/organization/{organizationId}

Returns the name, label and description of the organization, its storage consumed and its account statistics per offer.

Path parameters

organizationId
required
stringuuid

Organization ID

platformId
required
stringuuid

Platform ID

Response

200OrganizationResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
OrganizationCurrentState

Object representing organization

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
OrganizationPutTargetSpec

Object representing organization

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/organization/{organizationId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "description": "string",    "label": "string",    "name": "string",    "storageConsumed": 0,    "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": {    "description": "string",    "label": "string",    "name": "string"  }}

Create an organizationProduction

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

Creates an organization from its name, its label and an optional description. The label is a short name that must be unique on the platform. Creation is asynchronous: follow resourceStatus and currentTasks.

Path parameters

platformId
required
stringuuid

Platform ID

Request body (required)

targetSpec
required
OrganizationPostTargetSpec

Target organization specification

Response

200OrganizationResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
OrganizationCurrentState

Object representing organization

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
OrganizationPutTargetSpec

Object representing organization

400objectError 400 response
404objectError 404 response
409objectError 409 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/organization \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "description": "string",    "label": "string",    "name": "string",    "storageConsumed": 0,    "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": {    "description": "string",    "label": "string",    "name": "string"  }}

Delete an organizationProduction

DELETE
/v2/zimbra/platform/{platformId}/organization/{organizationId}

Deletes the organization. An organization still linked to domains cannot be deleted.

Path parameters

organizationId
required
stringuuid

Organization ID

platformId
required
stringuuid

Platform ID

Response

200—successful operation

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

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

Update an organizationProduction

PUT
/v2/zimbra/platform/{platformId}/organization/{organizationId}

Updates the name, label or description of the organization. When set, checksum must match the current checksum of the organization, otherwise the update is rejected.

Path parameters

organizationId
required
stringuuid

Organization ID

platformId
required
stringuuid

Platform ID

Request body (required)

checksum
string

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

targetSpec
required
OrganizationPutTargetSpec

Target organization specification

Response

200OrganizationResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
OrganizationCurrentState

Object representing organization

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
OrganizationPutTargetSpec

Object representing organization

400objectError 400 response
404objectError 404 response
409objectError 409 response
412objectError 412 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/organization/{organizationId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "accountsStatistics": [      {        "availableAccountsCount": 0,        "configuredAccountsCount": 0,        "offer": "PRO"      }    ],    "createdAt": "2024-01-01T12:00:00Z",    "description": "string",    "label": "string",    "name": "string",    "storageConsumed": 0,    "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": {    "description": "string",    "label": "string",    "name": "string"  }}