Redirections

All operations require authentication.

4 operationsv2/zimbra/platform

List redirectionsBeta

GET

/v2/zimbra/platform/{platformId}/redirection

Returns the redirections of the platform with their current state. Filter them by source, destination, domainId or organizationId.

Path parameters

platformId

required

stringuuid

Platform ID

Query parameters

destination

string

Filter by destination

domainId

string

Filter by domain id

organizationId

string

Filter by organization id

source

string

Filter by source

Headers

X-Pagination-Cursor

string

Pagination cursor

X-Pagination-Size

integer

Pagination size

Response

200RedirectionResponse[]successful operation

checksum

read-only

string

Checksum hash in MD5 representation

currentState

read-only

Redirection

Object representing Redirection

currentTasks

read-only

CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

read-only

stringuuid

Resource identifier in UUID representation

resourceStatus

read-only

ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

RedirectionBase

Object representing Redirection Target Spec

404objectError 404 response

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

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

ResponseExample

1[2  {3    "checksum": "string",4    "currentState": {5      "createdAt": "2024-01-01T12:00:00Z",6      "destination": "string",7      "domainId": "00000000-0000-0000-0000-000000000000",8      "organizationId": "00000000-0000-0000-0000-000000000000",9      "organizationLabel": "string",10      "source": "string",11      "updatedAt": "2024-01-01T12:00:00Z"12    },13    "currentTasks": [14      {15        "errors": [16          {17            "message": "string"18          }19        ],20        "id": "00000000-0000-0000-0000-000000000000",21        "link": "string",22        "status": "ERROR",23        "type": "string"24      }25    ],26    "id": "00000000-0000-0000-0000-000000000000",27    "resourceStatus": "CREATING",28    "targetSpec": {29      "destination": "string",30      "source": "string"31    }32  }33]

Get a redirectionBeta

GET

/v2/zimbra/platform/{platformId}/redirection/{redirectionId}

Returns the source and destination email addresses of the redirection, with its domain and organization.

Path parameters

platformId

required

stringuuid

Platform ID

redirectionId

required

stringuuid

Redirection ID

Response

200RedirectionResponsesuccessful operation

checksum

read-only

string

Checksum hash in MD5 representation

currentState

read-only

Redirection

Object representing Redirection

currentTasks

read-only

CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

read-only

stringuuid

Resource identifier in UUID representation

resourceStatus

read-only

ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

RedirectionBase

Object representing Redirection Target Spec

404objectError 404 response

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

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

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "createdAt": "2024-01-01T12:00:00Z",5    "destination": "string",6    "domainId": "00000000-0000-0000-0000-000000000000",7    "organizationId": "00000000-0000-0000-0000-000000000000",8    "organizationLabel": "string",9    "source": "string",10    "updatedAt": "2024-01-01T12:00:00Z"11  },12  "currentTasks": [13    {14      "errors": [15        {16          "message": "string"17        }18      ],19      "id": "00000000-0000-0000-0000-000000000000",20      "link": "string",21      "status": "ERROR",22      "type": "string"23    }24  ],25  "id": "00000000-0000-0000-0000-000000000000",26  "resourceStatus": "CREATING",27  "targetSpec": {28    "destination": "string",29    "source": "string"30  }31}

Create a redirectionBeta

POST

/v2/zimbra/platform/{platformId}/redirection

Creates a redirection from a source email address to a destination email address.

Path parameters

platformId

required

stringuuid

Platform ID

Request body (required)

targetSpec

required

RedirectionBase

Target redirection specification

Response

200RedirectionResponsesuccessful operation

checksum

read-only

string

Checksum hash in MD5 representation

currentState

read-only

Redirection

Object representing Redirection

currentTasks

read-only

CurrentTask[]

An array containing tasks responses pending on resource extends AsyncResourceBase object

read-only

stringuuid

Resource identifier in UUID representation

resourceStatus

read-only

ResourceStatusEnum

Current resource status

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

read-only

RedirectionBase

Object representing Redirection Target Spec

404objectError 404 response

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

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

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "createdAt": "2024-01-01T12:00:00Z",5    "destination": "string",6    "domainId": "00000000-0000-0000-0000-000000000000",7    "organizationId": "00000000-0000-0000-0000-000000000000",8    "organizationLabel": "string",9    "source": "string",10    "updatedAt": "2024-01-01T12:00:00Z"11  },12  "currentTasks": [13    {14      "errors": [15        {16          "message": "string"17        }18      ],19      "id": "00000000-0000-0000-0000-000000000000",20      "link": "string",21      "status": "ERROR",22      "type": "string"23    }24  ],25  "id": "00000000-0000-0000-0000-000000000000",26  "resourceStatus": "CREATING",27  "targetSpec": {28    "destination": "string",29    "source": "string"30  }31}

Delete a redirectionBeta

DELETE

/v2/zimbra/platform/{platformId}/redirection/{redirectionId}

Deletes the redirection.

Path parameters

platformId

required

stringuuid

Platform ID

redirectionId

required

stringuuid

Redirection ID

Response

200—successful operation

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

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