Cancel a workflow execution

Base URL: https://{kibana_url}

POST /api/workflows/executions/{executionId}/cancel
POST /s/{space_id}/api/workflows/executions/{executionId}/cancel

Refer to Spaces for more information.

Cancel a running workflow execution by its ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Response

200

Indicates a successful response

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/workflows/executions/{executionId}/cancel

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/executions/{executionId}/cancel" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true"

Response

No body