Skip to main content
DELETE
/
scenario-studio
/
jobs
/
{job_id}
Cancel Scenario job
curl --request DELETE \
  --url https://api.exec.com/rest/v1/scenario-studio/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "j1o2b3i4d5x6",
  "status": "cancelled",
  "scenario": null,
  "error": null,
  "created_at": "2024-03-01T10:00:00Z",
  "started_at": "2024-03-01T10:00:05Z",
  "completed_at": "2024-03-01T10:00:10Z",
  "duration_seconds": 5
}

Authorizations

​
Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Path Parameters

​
job_id
string
required

The job ID to cancel

Response

Job cancelled successfully

​
id
string

Job identifier

​
status
enum<string>

Current job status

Available options:
queued,
processing,
completed,
failed,
cancelled
​
scenario
object

Created scenario details (only present when status is "completed")

​
error
object

Error details (only present when status is "failed")

​
created_at
string<date-time>

When the job was created

​
started_at
string<date-time> | null

When the job started processing

​
completed_at
string<date-time> | null

When the job finished (success, failure, or cancelled)

​
duration_seconds
number | null

Processing duration in seconds (only present when job has completed)