Stop a running pipeline

Stop a running pipeline

Stops the pipeline, and marks it as failed.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}/stop

Path parameters

organizationId*integer

Organization ID

pipelineId*integer

Pipeline ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}/stop', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

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