Cancel job

Cancel a running job.

POST /api/organizations/{organizationId}/jobs/{jobId}/cancel

Try it

Cancel job

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/jobs/{jobId}/cancel \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

jobId · integer · required

Job ID

Query Parameters

forceCancel · string

If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

Optional error description (set if 'success' was false)