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

Tasks

All operations require authentication.

2 operationsv1/hosting/privateDatabase
OpenAPI
Agent setup

List tasksProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/tasks

Returns the IDs of the tasks of the service.

Path parameters

serviceName
required
string

Service name

Query parameters

function
FunctionEnum

Filter the value of function property

ValuesabusechangeFtpPasswordchangeRamchangeVersionconfiguration/updatecreatedatabase/copydatabase/copyRestoredatabase/createdatabase/deletedatabase/dumpdatabase/dump/deletedatabase/extension/createdatabase/extension/deletedatabase/importdatabase/restoredatabase/wizarddeletegrant/creategrant/deletegrant/updateinstalloverquota/inoverquota/outquotaRefreshrefreshreopenrestartstartstopsuspenduser/changePassworduser/createuser/deletewebhostingNetwork/disablewebhostingNetwork/enablewhitelist/createwhitelist/deletewhitelist/update
status
StatusEnum

Filter the value of status property

Valuescancelleddoingdoneerrortodo

Response

200integer[]successful operation

Example uses serviceName = string

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

Get a taskProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/tasks/{id}

Returns the function, status and dates of the task, and the database, user or dump it works on.

Path parameters

id
required
integer

Id

serviceName
required
string

Service name

Response

200Tasksuccessful operation
databaseName
read-only
string

Database name on which the task is working

doneDate
read-only
stringdate-time

Completion date

dumpId
read-only
integer

DumpId on which the task is working

function
read-only
FunctionEnum

Function name

ValuesabusechangeFtpPasswordchangeRamchangeVersionconfiguration/updatecreatedatabase/copydatabase/copyRestoredatabase/createdatabase/deletedatabase/dumpdatabase/dump/deletedatabase/extension/createdatabase/extension/deletedatabase/importdatabase/restoredatabase/wizarddeletegrant/creategrant/deletegrant/updateinstalloverquota/inoverquota/outquotaRefreshrefreshreopenrestartstartstopsuspenduser/changePassworduser/createuser/deletewebhostingNetwork/disablewebhostingNetwork/enablewhitelist/createwhitelist/deletewhitelist/update
id
read-only
integer

The id of the task

lastUpdate
read-only
stringdate-time

Last update

startDate
read-only
stringdate-time

Task creation date

status
read-only
StatusEnum

Task status

Valuescancelleddoingdoneerrortodo
userName
read-only
string

User name on which the task is working

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/tasks/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "databaseName": "string",  "doneDate": "2024-01-01T12:00:00Z",  "dumpId": 0,  "function": "abuse",  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "startDate": "2024-01-01T12:00:00Z",  "status": "cancelled",  "userName": "string"}