Skip to content

Tasks

All operations require authentication.

5 operationsv1/domain/zone
Agent setup

List tasksProduction

GET
/1.0/domain/zone/{zoneName}/task

Returns the identifiers of the zone tasks. Can be filtered by function and status.

Path parameters

zoneName
required
string

Zone name

Query parameters

function
TaskFunctionEnum

All functions from a dns task

ValuesDnsAnycastActivateDnsAnycastDeactivateDnssecDisableDnssecEnableDnssecResigningDnssecRollKskDnssecRollZskZoneCheckZoneCreateZoneCutZoneDeleteZoneImportZoneRefreshZoneRestore
status
TaskStatusEnum

All statuses from a dns task

Valuescancelleddoingdoneerrorproblemtodo

Response

200integer[]successful operation

Example uses zoneName = string

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

Get a taskProduction

GET
/1.0/domain/zone/{zoneName}/task/{id}

Returns a task: function, status, dates, and whether it can be accelerated, canceled or relaunched.

Path parameters

id
required
integer

Id

zoneName
required
string

Zone name

Response

200Tasksuccessful operation
canAccelerate
read-only
boolean

Can accelerate the task

canCancel
read-only
boolean

Can cancel the task

canRelaunch
read-only
boolean

Can relaunch the task

comment
read-only
string

Comment about the task

creationDate
read-only
stringdate-time

Creation date of the task

doneDate
read-only
stringdate-time

Done date of the task

function
read-only
TaskFunctionEnum

Function of the task

ValuesDnsAnycastActivateDnsAnycastDeactivateDnssecDisableDnssecEnableDnssecResigningDnssecRollKskDnssecRollZskZoneCheckZoneCreateZoneCutZoneDeleteZoneImportZoneRefreshZoneRestore
id
read-only
integer

Id of the task

lastUpdate
read-only
stringdate-time

Last update date of the task

status
read-only
TaskStatusEnum

Status of the task

Valuescancelleddoingdoneerrorproblemtodo
todoDate
read-only
stringdate-time

Todo date of the task

Example uses id = 0, zoneName = string

$ curl https://api.eu.ovhcloud.com/1.0/domain/zone/{zoneName}/task/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "canAccelerate": true, "canCancel": true, "canRelaunch": true, "comment": "string", "creationDate": "2024-01-01T12:00:00Z", "doneDate": "2024-01-01T12:00:00Z", "function": "DnsAnycastActivate", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}

Accelerate a taskProduction

POST
/1.0/domain/zone/{zoneName}/task/{id}/accelerate

Accelerates a task. Only possible when canAccelerate is true on the task.

Path parameters

id
required
integer

Id

zoneName
required
string

Zone name

Response

200—successful operation

Example uses id = 0, zoneName = string

$ curl https://api.eu.ovhcloud.com/1.0/domain/zone/{zoneName}/task/{id}/accelerate \
  -H "authorization: Bearer $OVH_TOKEN"

Relaunch a taskProduction

POST
/1.0/domain/zone/{zoneName}/task/{id}/relaunch

Relaunches a task. Only possible when canRelaunch is true on the task.

Path parameters

id
required
integer

Id

zoneName
required
string

Zone name

Response

200—successful operation

Example uses id = 0, zoneName = string

$ curl https://api.eu.ovhcloud.com/1.0/domain/zone/{zoneName}/task/{id}/relaunch \
  -H "authorization: Bearer $OVH_TOKEN"

Cancel a taskProduction

POST
/1.0/domain/zone/{zoneName}/task/{id}/cancel

Cancels a task. Only possible when canCancel is true on the task.

Path parameters

id
required
integer

Id

zoneName
required
string

Zone name

Response

200—successful operation

Example uses id = 0, zoneName = string

$ curl https://api.eu.ovhcloud.com/1.0/domain/zone/{zoneName}/task/{id}/cancel \
  -H "authorization: Bearer $OVH_TOKEN"