POST
/
api
/
svc
/
v1
/
jobs
/
trigger
Trigger Job
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,
    "sparkUi": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
deploymentId
string

Deployment Id of the job

applicationId
string

Application Id of the job

input
object

Job trigger input

Response

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

message
string
required

Job triggered

jobRunName
string
required

Name of the job run

data
object
required

Details of the triggered job run