Update a workflow

Base URL: https://{kibana_url}

PUT /api/workflows/workflow/{id}

Auth

Partially update an existing workflow. You can update individual fields such as name, description, enabled state, tags, or the YAML definition without providing all fields.

Required authorization

Privileges workflowsManagement:update

Path parameters

id string · max length: 255 required: Workflow ID

Header parameters

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

Request body

description string
enabled boolean
name string
tags string[]
yaml string

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request to enable a workflow and update its tags

Console Kibana Dev Tools

PUT kbn://api/workflows/workflow/{id}
{
  "enabled": true,
  "tags": ["production"]
}

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/workflows/workflow/{id}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "tags": ["production"]
  }'

Response

Example response returning the updated workflow

{
  "enabled": false,
  "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdatedAt": "2026-03-23T13:38:59.568Z",
  "lastUpdatedBy": "elastic",
  "valid": true,
  "validationErrors": []
}

Request Console 1 / 2 languages

Example request to update multiple workflow fields

Console Kibana Dev Tools

PUT kbn:/api/workflows/workflow/ID
{
  "description": "Updated workflow description",
  "enabled": true,
  "name": "Updated example",
  "tags": [
    "example",
    "updated"
  ],
  "yaml": "name: Updated example\nenabled: true\ndescription: Updated workflow description\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \u0022hello world\u0022\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \u0022{{ inputs.message }}\u0022\n"
}

Generated from the API spec

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/workflows/workflow/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated workflow description",
    "enabled": true,
    "name": "Updated example",
    "tags": [
      "example",
      "updated"
    ],
    "yaml": "name: Updated example\nenabled: true\ndescription: Updated workflow description\ntriggers:\n  - type: manual\ninputs:\n  - name: message\n    type: string\n    default: \u0022hello world\u0022\nsteps:\n  - name: hello_world_step\n    type: console\n    with:\n      message: \u0022{{ inputs.message }}\u0022\n"
  }'

Generated from the API spec

Response

Example response returning the updated workflow

{
  "enabled": false,
  "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdatedAt": "2026-03-23T13:38:59.568Z",
  "lastUpdatedBy": "elastic",
  "valid": true,
  "validationErrors": []
}

Required authorization

Path parameters

Header parameters

Request body { }

Response

Request body