Cancel job

Cancel job

Cancel a running job.

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

jobIdintegerrequired

Job ID

Query parameters

forceCancelstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "success": true,
  "error": "text"
}

OK