Workflows enable you to automate multi-step processes directly in Kibana. Define sequences of steps in YAML to transform data insights into automated actions and outcomes, without needing external automation tools. Use the workflows APIs to create, manage, and run workflows programmatically. You can also search, export, import, and monitor workflow executions.
openapi: 3.0.3
info:
contact:
name: Kibana Team
description: 'The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
The API calls are stateless.
Each request that you make happens in isolation from other calls and must include all of the necessary information for Kibana to fulfill the
request.
API requests return JSON output, which is a format that is machine-readable and works well for automation.
To interact with Kibana APIs, use the following operations:
- GET: Fetches the information.
- PATCH: Applies partial modifications to the existing information.
- POST: Adds new information.
- PUT: Updates the existing information.
- DELETE: Removes the information.
You can prepend any Kibana API endpoint with `kbn:` and run the request in **Dev Tools → Console**.
For example:
```
GET kbn:/api/data_views
```
For more information about the console, refer to [Run API requests](https://www.elastic.co/docs/explore-analyze/query-filter/tools/console).
NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.
## Documentation source and versions
This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
This documentation contains work-in-progress information for future Elastic Stack releases.
'
title: Kibana APIs Actions workflows API
version: ''
x-doc-license:
name: Attribution-NonCommercial-NoDerivatives 4.0 International
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
x-feedbackLink:
label: Feedback
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
variables:
kibana_url:
default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:
- name: workflows
description: 'Workflows enable you to automate multi-step processes directly in Kibana. Define sequences of steps in YAML to transform data insights into automated actions and outcomes, without needing external automation tools.
Use the workflows APIs to create, manage, and run workflows programmatically. You can also search, export, import, and monitor workflow executions.
'
externalDocs:
description: Workflows documentation
url: https://www.elastic.co/docs/explore-analyze/workflows
x-displayName: Workflows
paths:
/api/workflows:
delete:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb delete">delete</span> <span class="operation-path">/s/{space_id}/api/workflows</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Delete multiple workflows by their IDs.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:delete.'
operationId: delete-workflows
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: When true, permanently deletes the workflows (hard delete) instead of soft-deleting them. The workflow IDs become available for reuse.
in: query
name: force
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
examples:
bulkDeleteWorkflowsRequestExample:
description: Example request for deleting multiple workflows
value:
ids:
- workflow-c3d4e5f6-a7b8-9012-cdef-234567890123
- workflow-d4e5f6a7-b8c9-0123-defa-345678901234
schema:
additionalProperties: false
type: object
properties:
ids:
description: Array of workflow IDs to delete.
items:
description: Workflow ID to delete.
type: string
maxItems: 1000
type: array
required:
- ids
responses:
'200':
content:
application/json:
examples:
bulkDeleteWorkflowsResponseExample:
description: Example response after deleting multiple workflows
value:
deleted: 2
failures: []
total: 2
description: Indicates a successful response
summary: Bulk delete workflows
tags:
- workflows
x-codeSamples:
- label: Soft delete (default)
lang: curl
source: "curl \\\n -X DELETE \"${KIBANA_URL}/api/workflows\" \\\n -H \"Authorization: ApiKey ${API_KEY}\" \\\n -H \"kbn-xsrf: true\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ids\": [\"workflow-c3d4e5f6-a7b8-9012-cdef-234567890123\", \"workflow-d4e5f6a7-b8c9-0123-defa-345678901234\"]\n }'\n"
- label: Hard delete (permanent)
lang: curl
source: "curl \\\n -X DELETE \"${KIBANA_URL}/api/workflows?force=true\" \\\n -H \"Authorization: ApiKey ${API_KEY}\" \\\n -H \"kbn-xsrf: true\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ids\": [\"workflow-c3d4e5f6-a7b8-9012-cdef-234567890123\", \"workflow-d4e5f6a7-b8c9-0123-defa-345678901234\"]\n }'\n"
- lang: Console
source: "DELETE kbn://api/workflows\n{\n \"ids\": [\"workflow-c3d4e5f6-a7b8-9012-cdef-234567890123\", \"workflow-d4e5f6a7-b8c9-0123-defa-345678901234\"]\n}\n"
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve a paginated list of workflows with optional filtering.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:read OR workflowsManagement:readExecution.'
operationId: get-workflows
parameters:
- description: Free-text search query.
in: query
name: query
required: false
schema:
type: string
- description: Number of results per page.
in: query
name: size
required: false
schema:
minimum: 1
type: number
- description: Page number.
in: query
name: page
required: false
schema:
minimum: 1
type: number
- description: Filter by enabled state.
in: query
name: enabled
required: false
schema:
items:
type: boolean
maxItems: 2
type: array
- description: Filter by creator.
in: query
name: createdBy
required: false
schema:
items:
type: string
maxItems: 1000
type: array
- description: Filter by tags.
in: query
name: tags
required: false
schema:
items:
type: string
maxItems: 1000
type: array
responses:
'200':
content:
application/json:
examples:
getWorkflowsResponseExample:
description: Example response returning a paginated list of workflows
value:
page: 1
results:
- createdAt: '2025-11-20T10:30:00.000Z'
definition:
description: This is a workflow example
enabled: true
inputs:
- default: hello world
name: message
type: string
name: Example definition
steps:
- name: hello_world_step
type: console
with:
message: '{{ inputs.message }}'
triggers:
- type: manual
description: This is a workflow example
enabled: true
history:
- duration: 5000
finishedAt: '2025-11-20T12:00:05.000Z'
id: exec-001
startedAt: '2025-11-20T12:00:00.000Z'
status: completed
workflowId: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
workflowName: Example definition
id: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
name: Example definition
tags:
- example
valid: true
size: 20
total: 1
description: Indicates a successful response
summary: Get workflows
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows?size=20&page=1\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows?size=20&page=1
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
post:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/workflows</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Create multiple workflows in a single request. Optionally overwrite existing workflows.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:create AND workflowsManagement:update.'
operationId: post-workflows
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: Whether to overwrite existing workflows.
in: query
name: overwrite
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
examples:
bulkCreateWorkflowsRequestExample:
description: Example request for creating multiple workflows at once
value:
workflows:
- yaml: "name: Example definition\nenabled: true\ndescription: This is a workflow example\ntriggers:\n - type: manual\ninputs:\n - name: message\n type: string\n default: \"hello world\"\nsteps:\n - name: hello_world_step\n type: console\n with:\n message: \"{{ inputs.message }}\"\n"
- id: workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901
yaml: "name: Second workflow\nenabled: false\ndescription: Another workflow\ntriggers:\n - type: manual\nsteps:\n - name: log_step\n type: console\n with:\n message: \"Hello from second workflow\"\n"
schema:
additionalProperties: false
type: object
properties:
workflows:
items:
type: object
properties:
id:
maxLength: 255
minLength: 3
pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
type: string
yaml:
maxLength: 1048576
type: string
required:
- yaml
maxItems: 500
type: array
required:
- workflows
responses:
'200':
content:
application/json:
examples:
bulkCreateWorkflowsResponseExample:
description: Example response after creating multiple workflows
value:
created:
- id: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
name: Example definition
- id: workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901
name: Second workflow
failures: []
total: 2
description: Indicates a successful response
summary: Bulk create workflows
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X POST \"${KIBANA_URL}/api/workflows?overwrite=false\" \\\n -H \"Authorization: ApiKey ${API_KEY}\" \\\n -H \"kbn-xsrf: true\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"workflows\": [\n { \"yaml\": \"name: Example definition\\nenabled: true\\ndescription: This is a workflow example\\ntriggers:\\n - type: manual\\ninputs:\\n - name: message\\n type: string\\n default: \\\"hello world\\\"\\nsteps:\\n - name: hello_world_step\\n type: console\\n with:\\n message: \\\"{{ inputs.message }}\\\"\\n\" },\n { \"id\": \"workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901\", \"yaml\": \"name: Second workflow\\nenabled: false\\ndescription: Another workflow\\ntriggers:\\n - type: manual\\nsteps:\\n - name: log_step\\n type: console\\n with:\\n message: \\\"Hello from second workflow\\\"\\n\" }\n ]\n }'\n"
- lang: Console
source: "POST kbn://api/workflows?overwrite=false\n{\n \"workflows\": [\n { \"yaml\": \"name: Example definition\\nenabled: true\\ndescription: This is a workflow example\\ntriggers:\\n - type: manual\\ninputs:\\n - name: message\\n type: string\\n default: \\\"hello world\\\"\\nsteps:\\n - name: hello_world_step\\n type: console\\n with:\\n message: \\\"{{ inputs.message }}\\\"\\n\" },\n { \"id\": \"workflow-b2c3d4e5-f6a7-8901-bcde-f12345678901\", \"yaml\": \"name: Second workflow\\nenabled: false\\ndescription: Another workflow\\ntriggers:\\n - type: manual\\nsteps:\\n - name: log_step\\n type: console\\n with:\\n message: \\\"Hello from second workflow\\\"\\n\" }\n ]\n}\n"
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/aggs:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows/aggs</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve distinct values and their counts for the specified workflow fields. Useful for building filters such as lists of tags or creators.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:read.'
operationId: get-workflows-aggs
parameters:
- description: Field or fields to aggregate on.
in: query
name: fields
required: true
schema:
description: Fields to aggregate on.
items:
description: Field name to aggregate.
type: string
maxItems: 25
type: array
responses:
'200':
content:
application/json:
examples:
getAggsResponseExample:
description: Example response with tag and createdBy aggregations
value:
createdBy:
- doc_count: 2
key: elastic
tags:
- doc_count: 1
key: reporting
- doc_count: 1
key: security
- doc_count: 1
key: triage
description: Indicates a successful response
summary: Get workflow aggregations
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows/aggs?fields=tags&fields=createdBy\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows/aggs?fields=tags&fields=createdBy
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/connectors:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows/connectors</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve the Kibana action connectors that can be used in workflow steps, grouped by connector type. Each type includes its configured instances and availability status.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:read.'
operationId: get-workflows-connectors
parameters: []
responses:
'200':
content:
application/json:
examples:
getConnectorsResponseExample:
description: Example response with available connector types and their instances
value:
connectorTypes:
.email:
actionTypeId: .email
displayName: Email
enabled: true
enabledInConfig: true
enabledInLicense: true
instances: []
minimumLicenseRequired: gold
subActions:
- displayName: Send
name: send
.slack_api:
actionTypeId: .slack_api
displayName: Slack
enabled: true
enabledInConfig: true
enabledInLicense: true
instances:
- id: slack-connector-1
isDeprecated: false
isPreconfigured: false
name: Team Notifications
minimumLicenseRequired: gold
subActions:
- displayName: Post Message
name: postMessage
totalConnectors: 1
description: Indicates a successful response
summary: Get available connectors
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows/connectors\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows/connectors
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/executions/{executionId}:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve details of a single workflow execution by its ID.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:readExecution.'
operationId: get-workflows-executions-executionid
parameters:
- description: Workflow execution ID
in: path
name: executionId
required: true
schema:
type: string
- description: Include execution input data.
in: query
name: includeInput
required: false
schema:
default: false
type: boolean
- description: Include execution output data.
in: query
name: includeOutput
required: false
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
examples:
getExecutionResponseExample:
description: Example response returning a workflow execution with step details
value:
duration: 3000
executedBy: elastic
finishedAt: '2025-11-20T12:00:03.000Z'
id: exec-a1b2c3d4-e5f6-7890
input:
message: hello world
isTestRun: false
output: hello world
spaceId: default
startedAt: '2025-11-20T12:00:00.000Z'
status: completed
stepExecutions:
- executionTimeMs: 1000
finishedAt: '2025-11-20T12:00:02.000Z'
globalExecutionIndex: 0
id: step-exec-001
isTestRun: false
scopeStack: []
spaceId: default
startedAt: '2025-11-20T12:00:01.000Z'
status: completed
stepExecutionIndex: 0
stepId: hello_world_step
stepType: console
topologicalIndex: 0
workflowId: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
workflowRunId: exec-a1b2c3d4-e5f6-7890
triggeredBy: manual
workflowDefinition:
description: This is a workflow example
enabled: true
inputs:
- default: hello world
name: message
type: string
name: Example definition
steps:
- name: hello_world_step
type: console
with:
message: '{{ inputs.message }}'
triggers:
- type: manual
workflowId: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
yaml: "name: Example definition\nenabled: true\ndescription: This is a workflow example\ntriggers:\n - type: manual\ninputs:\n - name: message\n type: string\n default: \"hello world\"\nsteps:\n - name: hello_world_step\n type: console\n with:\n message: \"{{ inputs.message }}\"\n"
description: Indicates a successful response
summary: Get a workflow execution
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows/executions/{executionId}?includeInput=true&includeOutput=true\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows/executions/{executionId}?includeInput=true&includeOutput=true
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/executions/{executionId}/cancel:
post:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}/cancel</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Cancel a running workflow execution by its ID.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:cancelExecution.'
operationId: post-workflows-executions-executionid-cancel
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: Workflow execution ID
in: path
name: executionId
required: true
schema:
type: string
responses:
'200':
description: Indicates a successful response
summary: Cancel a workflow execution
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X POST \"${KIBANA_URL}/api/workflows/executions/{executionId}/cancel\" \\\n -H \"Authorization: ApiKey ${API_KEY}\" \\\n -H \"kbn-xsrf: true\"\n"
- lang: Console
source: 'POST kbn://api/workflows/executions/{executionId}/cancel
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/executions/{executionId}/children:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}/children</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve child workflow executions spawned by sub-workflow steps within a parent execution.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:readExecution.'
operationId: get-workflows-executions-executionid-children
parameters:
- description: Workflow execution ID
in: path
name: executionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
getChildrenExecutionsResponseExample:
description: Example response returning child workflow executions spawned by sub-workflow steps
value:
- executionId: child-exec-001
parentStepExecutionId: step-exec-003
status: completed
stepExecutions:
- executionTimeMs: 1000
finishedAt: '2025-11-20T12:00:07.000Z'
globalExecutionIndex: 0
id: child-step-001
isTestRun: false
scopeStack: []
startedAt: '2025-11-20T12:00:06.000Z'
status: completed
stepExecutionIndex: 0
stepId: hello_world_step
stepType: console
topologicalIndex: 0
workflowId: workflow-e5f6a7b8-c9d0-1234-efab-456789012345
workflowRunId: child-exec-001
workflowId: workflow-e5f6a7b8-c9d0-1234-efab-456789012345
workflowName: Child Workflow
description: Indicates a successful response
summary: Get child executions
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows/executions/{executionId}/children\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows/executions/{executionId}/children
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/executions/{executionId}/logs:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}/logs</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Retrieve paginated logs for a workflow execution. Optionally filter by a specific step execution.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:readExecution.'
operationId: get-workflows-executions-executionid-logs
parameters:
- description: Workflow execution ID
in: path
name: executionId
required: true
schema:
type: string
- description: Filter logs by a specific step execution ID.
in: query
name: stepExecutionId
required: false
schema:
type: string
- description: Number of log entries per page.
in: query
name: size
required: false
schema:
default: 100
maximum: 100
minimum: 1
type: number
- description: Page number.
in: query
name: page
required: false
schema:
default: 1
minimum: 1
type: number
- description: Field to sort by.
in: query
name: sortField
required: false
schema:
type: string
- description: Sort order.
in: query
name: sortOrder
required: false
schema:
enum:
- asc
- desc
type: string
responses:
'200':
content:
application/json:
examples:
getExecutionLogsResponseExample:
description: Example response returning paginated execution logs
value:
logs:
- additionalData:
executionId: exec-a1b2c3d4-e5f6-7890
workflowId: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
connectorType: console
duration: 150
id: log-001
level: info
message: Workflow execution started
stepId: hello_world_step
stepName: Hello World
timestamp: '2025-11-20T12:00:01.000Z'
- additionalData:
executionId: exec-a1b2c3d4-e5f6-7890
workflowId: workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890
connectorType: console
duration: 200
id: log-002
level: info
message: Step completed successfully
stepId: hello_world_step
stepName: Hello World
timestamp: '2025-11-20T12:00:02.000Z'
page: 1
size: 100
total: 2
description: Indicates a successful response
summary: Get execution logs
tags:
- workflows
x-codeSamples:
- lang: curl
source: "curl \\\n -X GET \"${KIBANA_URL}/api/workflows/executions/{executionId}/logs?size=100&page=1\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n"
- lang: Console
source: 'GET kbn://api/workflows/executions/{executionId}/logs?size=100&page=1
'
x-state: Generally available; added in 9.4.0
x-metaTags:
- content: Kibana
name: product_name
/api/workflows/executions/{executionId}/resume:
post:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}/resume</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Resume a paused workflow execution with the prov
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kibana/refs/heads/main/openapi/kibana-workflows-api-openapi.yml