Get workflows by IDs

Base URL: https://{kibana_url}

POST /api/workflows/mget

Auth

Retrieve multiple workflows by their IDs in a single request. Optionally use the source parameter to return only specific fields from each workflow document.

Required privileges

Privileges workflowsManagement:read or workflowsManagement:managed:read

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

ids string[] · min items: 1 · max items: 500 required: Array of workflow IDs to look up.
source string[] · min items: 1 · max items: 10: Array of source fields to include.

Response

200

Indicates a successful response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request to retrieve multiple workflows by their IDs

Console Kibana Dev Tools

POST kbn://api/workflows/mget
{
  "ids": ["workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901"],
  "source": ["name", "enabled"]
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/mget" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901"],
    "source": ["name", "enabled"]
  }'

Response

Example response returning the requested workflows with projected fields

[
  {
    "enabled": true,
    "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Example definition"
  },
  {
    "enabled": false,
    "id": "workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Second workflow"
  }
]

Required privileges

Header parameters

Request body { }

Response

Request body