Register a job

Contributors

POST /api/account/{accountId}/v1/jobs

Registers a job and creates an entry in the Cloud Backup database by using this Cloud Manager backend service API endpoint. You can register a new job with a job name, job type (volume_backup, restore), job status (RUNNING, COMPLETED, QUEUED, WARNING, FAILED), service type (CBS, SnapCenterService, K8S), start time, description, error, and resolution.

Token usage: Cloud Manager user token.

Parameters

Name Type In Required Description

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

name

string

True

Name of the job

service

string

True

Service accessing the job API

status

string

True

Status of the current job

startTime

number

True

Time in milliseconds when the job started

data

data

False

JSON data containing data specific to a job

parentJobId

string

False

Job ID of the parent job under which the current job must be grouped

type

string

True

description

string

False

Brief description about the job

error

string

False

resolution

string

False

Resolution for the error

Response

Status: 200, Default response
Name Type Required Description

id

string

False

Job ID of the newly created job

Definitions

data

JSON data containing data specific to a job

body
Name Type Required Description

name

string

True

Name of the job

service

string

True

Service accessing the job API

status

string

True

Status of the current job

startTime

number

True

Time in milliseconds when the job started

data

data

False

JSON data containing data specific to a job

parentJobId

string

False

Job ID of the parent job under which the current job must be grouped

type

string

True

description

string

False

Brief description about the job

error

string

False

resolution

string

False

Resolution for the error