POST
/
api
/
svc
/
v1
/
jobs
/
trigger
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/jobs/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deploymentId": "<string>",
  "applicationId": "<string>",
  "input": {
    "command": "<string>",
    "params": {}
  }
}'
{
  "message": "<string>",
  "jobRunName": "<string>",
  "data": {
    "name": "<string>",
    "applicationName": "<string>",
    "deploymentVersion": "<string>",
    "createdAt": 123,
    "endTime": 123,
    "duration": 123,
    "command": "<string>",
    "totalRetries": 123,
    "error": "<string>",
    "status": "CREATED",
    "triggeredBy": "<string>",
    "triggeredBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "exitCode": 123,
    "externalId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Returns object with message, JobRun Name And Job Details on successful creation of Job

The response is of type object.