Terminate Job

curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/jobs/terminate \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>"
}

POST

api

svc

jobs

terminate

Terminate Job

curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/jobs/terminate \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>"
}

Authorization

string

header

required

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

deploymentId

string

required

Deployment Id of the Deployment

jobRunName

string

required

Job Run name

Returns object with message and JobRun Status on successful termination of Job

message

string

required

Terminate Job Message

jobRunStatus

enum<string>

required

Job run status

Available options:

CREATED,

SCHEDULED,

RUNNING,

FINISHED,

FAILED,

TERMINATION_REQUESTED,

TERMINATING,

TERMINATED,

UNKNOWN

⌘I