Skip to content

Tasks

All operations require authentication.

2 operationsv1/sslGateway/{serviceName}
Agent setup

List tasksBeta

GET
/1.0/sslGateway/{serviceName}/task

Path parameters

serviceName
required
string

The internal name of your SSL Gateway

Response

200integer[]successful operation

Example uses serviceName = string

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

Get a taskBeta

GET
/1.0/sslGateway/{serviceName}/task/{id}

Path parameters

id
required
integer

Id of the task

serviceName
required
string

The internal name of your SSL Gateway

Response

200Tasksuccessful operation
action
read-only
TaskActionEnum

The action made

ValuesaddDomainaddPaidCertificateaddServercreateServicedeleteDomaindeleteServerdeleteServiceinternalTaskupdateServerupdateServiceupgrade
creationDate
read-only
stringdate-time

Creation date of your task

id
read-only
integer

Id of the task

progress
read-only
integer

Task progress percentage

status
read-only
TaskStatusEnum

Current status of your task

Valuesblockedcancelleddoingdoneerrorpausedtodo

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/sslGateway/{serviceName}/task/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "addDomain", "creationDate": "2024-01-01T12:00:00Z", "id": 0, "progress": 0, "status": "blocked"}