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": {}
},
"metadata": {
"job_run_name_alias": "<string>"
}
}
'{
"message": "<string>",
"jobRunName": "<string>",
"data": {
"name": "<string>",
"applicationName": "<string>",
"deploymentVersion": "<string>",
"createdAt": 123,
"command": "<string>",
"totalRetries": 123,
"status": "CREATED",
"endTime": 123,
"duration": 123,
"error": "<string>",
"triggeredBy": "<string>",
"triggeredBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"exitCode": 123,
"sparkUi": "<string>"
}
}Trigger Job for provided deploymentId or applicationId
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": {}
},
"metadata": {
"job_run_name_alias": "<string>"
}
}
'{
"message": "<string>",
"jobRunName": "<string>",
"data": {
"name": "<string>",
"applicationName": "<string>",
"deploymentVersion": "<string>",
"createdAt": 123,
"command": "<string>",
"totalRetries": 123,
"status": "CREATED",
"endTime": 123,
"duration": 123,
"error": "<string>",
"triggeredBy": "<string>",
"triggeredBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"exitCode": 123,
"sparkUi": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Deployment Id of the job
Application Id of the job
Returns object with message, JobRun Name And Job Details on successful creation of Job
Job triggered
Name of the job run
Details of the triggered job run
Show child attributes
JobRun Name
Application Name
Deployment Version
Created At
Command
Total Retries
Status of JobRun
CREATED, SCHEDULED, RUNNING, FINISHED, FAILED, TERMINATION_REQUESTED, TERMINATING, TERMINATED, UNKNOWN End Time of JobRun
Duration of JobRun
Error
Triggered By
Triggered By Subject
Show child attributes
Subject ID
Subject type
user, team, serviceaccount, virtualaccount Subject slug
Subject display name
Exit Code
Spark UI Url
Was this page helpful?