Cancel a workflow

DELETE

/api/v1/workflows/invocations/{id}

const url = 'https://api.yggy.tech/api/v1/workflows/invocations/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.yggy.tech/api/v1/workflows/invocations/example \
  --header 'Authorization: Bearer <token>'

Cancel a running or queued workflow. Waiting/delayed jobs are removed; active jobs are marked for cancellation.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

202

Cancellation requested; worker will stop at next safe checkpoint

204

Workflow removed from the queue

404

Workflow not found

409

Workflow already finished