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

Aliases

All operations require authentication.

4 operationsv2/zimbra/platform
OpenAPI
Agent setup

List aliasesProduction

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

Returns the aliases of the platform with their target. Filter them by alias, aliasTargetId, aliasOrganizationId or aliasOrganizationLabel.

Path parameters

platformId
required
stringuuid

Platform ID

Query parameters

alias
string

Filter by the alias email

aliasOrganizationId
string

Filter by organization identifier of the aliases

aliasOrganizationLabel
string

Filter by organization label of the aliases

aliasTargetId
string

Filter by the targeted email account identifier

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200AliasResponse[]successful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
Alias

Object representing Alias

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
AliasBase

Object representing Alias

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/alias \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "checksum": "string",    "currentState": {      "alias": {        "domainId": "00000000-0000-0000-0000-000000000000",        "name": "string",        "organizationId": "00000000-0000-0000-0000-000000000000",        "organizationLabel": "string"      },      "target": {        "domainId": "00000000-0000-0000-0000-000000000000",        "id": "00000000-0000-0000-0000-000000000000",        "type": "ACCOUNT"      }    },    "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": {      "alias": "string",      "targetId": "00000000-0000-0000-0000-000000000000"    }  }]

Get an aliasProduction

GET
/v2/zimbra/platform/{platformId}/alias/{aliasId}

Returns the alias address, its domain and organization, and its target: an email account or a mailing list.

Path parameters

aliasId
required
stringuuid

Alias ID

platformId
required
stringuuid

Platform ID

Response

200AliasResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
Alias

Object representing Alias

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
AliasBase

Object representing Alias

400objectError 400 response
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/zimbra/platform/{platformId}/alias/{aliasId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "alias": {      "domainId": "00000000-0000-0000-0000-000000000000",      "name": "string",      "organizationId": "00000000-0000-0000-0000-000000000000",      "organizationLabel": "string"    },    "target": {      "domainId": "00000000-0000-0000-0000-000000000000",      "id": "00000000-0000-0000-0000-000000000000",      "type": "ACCOUNT"    }  },  "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": {    "alias": "string",    "targetId": "00000000-0000-0000-0000-000000000000"  }}

Create an aliasProduction

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

Creates an alias address from alias and the ID of its target in targetId. The alias domain and the target domain must be in the same organization.

Path parameters

platformId
required
stringuuid

Platform ID

Request body (required)

targetSpec
required
AliasBase

Target alias specification

Response

200AliasResponsesuccessful operation
checksum
read-only
string

Checksum hash in MD5 representation

currentState
read-only
Alias

Object representing Alias

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
AliasBase

Object representing Alias

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}/alias \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "currentState": {    "alias": {      "domainId": "00000000-0000-0000-0000-000000000000",      "name": "string",      "organizationId": "00000000-0000-0000-0000-000000000000",      "organizationLabel": "string"    },    "target": {      "domainId": "00000000-0000-0000-0000-000000000000",      "id": "00000000-0000-0000-0000-000000000000",      "type": "ACCOUNT"    }  },  "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": {    "alias": "string",    "targetId": "00000000-0000-0000-0000-000000000000"  }}

Delete an aliasProduction

DELETE
/v2/zimbra/platform/{platformId}/alias/{aliasId}

Deletes the alias address. The alias, its domain and its target must be ready.

Path parameters

aliasId
required
stringuuid

Alias ID

platformId
required
stringuuid

Platform ID

Response

200—successful operation

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

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