Skip to content

Tasks

All operations require authentication.

4 operationsv1/email/pro
Agent setup

List email account tasksAlpha

GET
/1.0/email/pro/{service}/account/{email}/tasks

Returns the IDs of the tasks of the email account. Read one with GET /email/pro/{service}/task/{id}.

Path parameters

email
required
string

Email

service
required
string

Service

Response

200integer[]successful operation

Example uses email = string, service = string

$ curl https://api.eu.ovhcloud.com/1.0/email/pro/{service}/account/{email}/tasks \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a taskAlpha

GET
/1.0/email/pro/{service}/account/{email}/tasks/{id}

Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.

Path parameters

email
required
string

Email

id
required
integer

Id

service
required
string

Service

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesaddAccountaddAliasaddDomainaddDomainDKIMaddDomainDisclaimeraddExternalContactaddFullAccessaddSendAsaddSendOnBehalfToaddServiceAuthorizedIpchangeHostnamechangePasswordconfigureCustomerdeleteAccountdeleteAliasdeleteDomaindeleteDomainDKIMdeleteDomainDisclaimerdeleteExternalContactdeleteFullAccessdeleteSendAsdeleteSendOnBehalfTodeleteServicedeleteServiceAuthorizedIpdiagnoseAccountdisableDKIMenableDKIMexpandDriveinstallServermaintenancemigrateAccountViaOMMmigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationServicereOpenAccountsetAccountsetAliassetDnssetDomainsetDomainDisclaimersetExternalContactsetServicesuspendAccountsuspendServiceunknownunsuspendAccountunsuspendService
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses email = string, id = 0, service = string

$ curl https://api.eu.ovhcloud.com/1.0/email/pro/{service}/account/{email}/tasks/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "finishDate": "2024-01-01T12:00:00Z", "function": "addAccount", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}

List service tasksAlpha

GET
/1.0/email/pro/{service}/task

Returns the IDs of the tasks of the service. Get one to follow its function, status and dates.

Path parameters

service
required
string

Service

Response

200integer[]successful operation

Example uses service = string

$ curl https://api.eu.ovhcloud.com/1.0/email/pro/{service}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a taskAlpha

GET
/1.0/email/pro/{service}/task/{id}

Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.

Path parameters

id
required
integer

Id

service
required
string

Service

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesaddAccountaddAliasaddDomainaddDomainDKIMaddDomainDisclaimeraddExternalContactaddFullAccessaddSendAsaddSendOnBehalfToaddServiceAuthorizedIpchangeHostnamechangePasswordconfigureCustomerdeleteAccountdeleteAliasdeleteDomaindeleteDomainDKIMdeleteDomainDisclaimerdeleteExternalContactdeleteFullAccessdeleteSendAsdeleteSendOnBehalfTodeleteServicedeleteServiceAuthorizedIpdiagnoseAccountdisableDKIMenableDKIMexpandDriveinstallServermaintenancemigrateAccountViaOMMmigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationServicereOpenAccountsetAccountsetAliassetDnssetDomainsetDomainDisclaimersetExternalContactsetServicesuspendAccountsuspendServiceunknownunsuspendAccountunsuspendService
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses id = 0, service = string

$ curl https://api.eu.ovhcloud.com/1.0/email/pro/{service}/task/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "finishDate": "2024-01-01T12:00:00Z", "function": "addAccount", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}