Elastic Stack

Elastic Stack (ELK Stack) Connectors API

Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/actions/connector_types List available connector types · Get connector types #
Ask an LLM
“What kinds of connectors can I set up in Kibana?”
“Which connector types support cases or alerting?”
Tell an agent
List all available connector types.
Show connector types that support feature {feature_id}.
GET /api/actions/connector/_oauth_callback Complete a connector's OAuth callback · Handle OAuth callback #
Ask an LLM
“How does a connector exchange the OAuth authorization code for tokens?”
“What does the connector OAuth callback do when the provider returns an error?”
Tell an agent
Complete the connector OAuth callback with code {code} and state {state}.
Handle the connector OAuth failure {error} described as {error_description}.
GET /api/actions/connector/{connectorId}/oauth/start Start OAuth authorization for a connector · Start OAuth authorization (redirects to the identity provider) #
Ask an LLM
“How do I kick off the OAuth sign-in for a connector?”
“Where does a connector send me to authorize with the identity provider?”
Tell an agent
Start OAuth authorization for connector {connectorId}.
Redirect me to the identity provider to authorize connector {connectorId}.
DELETE /api/actions/connector/{id} Delete a connector · Delete a connector #
Ask an LLM
“How do I delete a connector I no longer use?”
“Can a deleted connector be recovered?”
Tell an agent destructive · confirm first
Delete connector {id}.
Permanently remove connector {id}.
GET /api/actions/connector/{id} Get a connector's details · Get connector information #
Ask an LLM
“How do I look up the configuration of one connector?”
“Can I see what type a specific connector is?”
Tell an agent
Get connector {id}.
Show the details of connector {id}.
POST /api/actions/connector/{id} Create a connector with a chosen ID · Create a connector #
Ask an LLM
“How do I create a new connector in Kibana with my own ID?”
“What fields are required to set up a new connector, such as its type and name?”
Tell an agent
Create a {connector_type_id} connector {id} named {name}.
Set up new connector {id} of type {connector_type_id} called {name} with config {config}.
PUT /api/actions/connector/{id} Update a connector · Update a connector #
Ask an LLM
“How do I rename or reconfigure an existing connector?”
“Can I update a connector's secrets without recreating it?”
Tell an agent
Rename connector {id} to {name}.
Update connector {id} named {name} with config {config}.
POST /api/actions/connector/{id}/_execute Run a connector · Run a connector #
Ask an LLM
“How do I test a connector by running it?”
“Can I trigger a connector action on demand with custom parameters?”
Tell an agent
Run connector {id} with params {params}.
Execute connector {id} as a test using {params}.
GET /api/actions/connectors List all connectors · Get all connectors #
Ask an LLM
“What connectors are configured in my Kibana space?”
“Can I see every connector at once?”
Tell an agent
List all my connectors.
Show every connector set up in this space.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-connectors-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-connectors-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-connectors-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    name: Kibana Team
  description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
  title: Kibana Connectors 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:


# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-connectors-api-openapi.yml