hog_flows

Cancel in-flight invocations of this workflow, by id or all at once.

Cancellation is asynchronous: runs are flagged here, then terminated by the workflow workers, promptly for parked runs (delays and waits) and at the next step boundary for runs mid-execution. Steps that already executed are not undone. Canceled runs can be re-run later via rerun.

post/api/projects/{project_id}/hog_flows/{id}/invocations/cancel/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/{id}/invocations/cancel/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog flow.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

invocation_idsstring[]

Cancel these specific invocations. Capped at 10000 per request. Invocations that already finished are skipped rather than failing the request.

allboolean

Cancel every in-flight invocation of this workflow, including parked delays and waits.

Response

markedinteger required

In-flight runs newly flagged for cancellation by this request.

remaininginteger required

Matching in-flight runs not yet flagged. Non-zero on very large workflows; call again.

doneboolean required

True when no matching in-flight runs remain unflagged.

Changes

No recorded changes to this operation across all 1 revision of this API.