Elastic

Elastic Connector API

The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. Connectors are Elasticsearch integrations for syncing content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid. This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege.

GitHub OpenAPI

Operations 30

PUT /_connector/{connector_id}/_check_in Check in a connector #
GET /_connector/{connector_id} Get a connector #
PUT /_connector/{connector_id} Create or update a connector #
DELETE /_connector/{connector_id} Delete a connector #
GET /_connector Get all connectors #
PUT /_connector Create or update a connector #
POST /_connector Create a connector #
PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel Cancel a connector sync job #
PUT /_connector/_sync_job/{connector_sync_job_id}/_check_in Check in a connector sync job #
PUT /_connector/_sync_job/{connector_sync_job_id}/_claim Claim a connector sync job #
GET /_connector/_sync_job/{connector_sync_job_id} Get a connector sync job #
DELETE /_connector/_sync_job/{connector_sync_job_id} Delete a connector sync job #
PUT /_connector/_sync_job/{connector_sync_job_id}/_error Set a connector sync job error #
GET /_connector/_sync_job Get all connector sync jobs #
POST /_connector/_sync_job Create a connector sync job #
PUT /_connector/_sync_job/{connector_sync_job_id}/_stats Set the connector sync job stats #
PUT /_connector/{connector_id}/_filtering/_activate Activate the connector draft filter #
PUT /_connector/{connector_id}/_api_key_id Update the connector API key ID #
PUT /_connector/{connector_id}/_configuration Update the connector configuration #
PUT /_connector/{connector_id}/_error Update the connector error field #
PUT /_connector/{connector_id}/_features Update the connector features #
PUT /_connector/{connector_id}/_filtering Update the connector filtering #
PUT /_connector/{connector_id}/_filtering/_validation Update the connector draft filtering validation #
PUT /_connector/{connector_id}/_index_name Update the connector index name #
PUT /_connector/{connector_id}/_name Update the connector name and description #
PUT /_connector/{connector_id}/_native Update the connector is_native flag #
PUT /_connector/{connector_id}/_pipeline Update the connector pipeline #
PUT /_connector/{connector_id}/_scheduling Update the connector scheduling #
PUT /_connector/{connector_id}/_service_type Update the connector service type #
PUT /_connector/{connector_id}/_status Update the connector status #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-connector-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

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/elastic:elastic-connector-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

elastic-connector-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elasticsearch Connector API
  description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.

    ## Documentation source and versions

    This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

    This documentation contains work-in-progress information for future Elastic Stack releases.'
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
security:
- apiKeyAuth: []
- basicAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-connector-api-openapi.yml