Get workflow JSON schema

Base URL: https://{kibana_url}

GET /api/workflows/schema

Retrieve the JSON schema used to validate workflow YAML definitions. The schema includes available step types based on the configured connectors in the current space.

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>

Query parameters

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/workflows/schema?loose=false

curl Shell

curl \
  -X GET "${KIBANA_URL}/api/workflows/schema?loose=false" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Example response returning the workflow JSON schema (truncated)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "description": {
      "type": "string"
    },
    "enabled": {
      "default": true,
      "type": "boolean"
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "version": {
      "const": "1",
      "default": "1",
      "description": "The version of the workflow schema",
      "type": "string"
    }
  },
  "required": [
    "name",
    "triggers",
    "steps"
  ]
}