workspaces

Suspends all flows in the specified workspace

Suspends all active flows (excluding debug and retry flows) in the specified workspace. You need to have the workspaces.workspace.suspend_flows permission to access this resource.

post/workspaces/{workspace_id}/flows/suspend

Request

  • Base URL: https://api.elastic.io/v2
  • URL: https://api.elastic.io/v2/workspaces/{workspace_id}/flows/suspend
  • Auth: HTTP basic

Path parameters

workspace_idstring required

Workspace identifier

Query parameters

reasonstring
Example:quota-overlay

Optional reason for suspension. Use quota-overlay when suspending due to quota limits exceeded. When set to quota-overlay, flows will be marked with suspendedByQuota field.

Response

Accepted

suspendedinteger required

Number of flows successfully suspended

Changes

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