Update a job

Contributors

PATCH /api/account/{accountId}/v1/jobs/{jobId}

Updates a specific job in the Cloud Backup database by using the Cloud Manager backend service API endpoint. You can modify the job status (RUNNING, COMPLETED, QUEUED, WARNING, FAILED), job description, job end time, error, and resolution.

Token usage: Cloud Manager user token.

Parameters

Name Type In Required Description

jobId

string

path

True

Job ID

accountId

string

path

True

Account ID

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Request Body

Name Type Required Description

status

string

False

Status of the current job

description

string

False

data

data

False

JSON data containing data specific to a job

endTime

number

False

Time in milliseconds when the job ended

error

string

False

resolution

string

False

Resolution for the error

Example request

{
  "status": "RUNNING"
}

Response

Status: 200, Default response

Definitions

data

JSON data containing data specific to a job

body
Name Type Required Description

status

string

False

Status of the current job

description

string

False

data

data

False

JSON data containing data specific to a job

endTime

number

False

Time in milliseconds when the job ended

error

string

False

resolution

string

False

Resolution for the error