How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Stack (ELK Stack)

Elastic Stack (ELK Stack) Connector API

The connector API from Elastic Stack (ELK Stack) — 24 operation(s) for connector.

Documentation Provider Profile APIs.io OpenAPI GitHub

Elastic Stack (ELK Stack) Connector API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Connector. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 30 operations across 24 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

30 operations 24 paths 52 schemas 2 DELETE4 GET2 POST22 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Apache 2.0
Resource Areas
1

Paths & Operations 30

Across 24 paths, the API surfaces 30 operations — 2 DELETE, 4 GET, 2 POST, 22 PUT. Each is listed below with its method, path, parameters, and response codes.

connector 30
PUT
/_connector/{connector_id}/_check_in
Check in a connector
connector-check-in 1 param → 200
GET
/_connector/{connector_id}
Get a connector
connector-get 2 params → 200
PUT
/_connector/{connector_id}
Create or update a connector
connector-put 1 param body → 200
DELETE
/_connector/{connector_id}
Delete a connector
connector-delete 3 params → 200
GET
/_connector
Get all connectors
connector-list 7 params → 200
PUT
/_connector
Create or update a connector
connector-put-1 body → 200
POST
/_connector
Create a connector
connector-post body → 200
PUT
/_connector/_sync_job/{connector_sync_job_id}/_cancel
Cancel a connector sync job
connector-sync-job-cancel 1 param → 200
PUT
/_connector/_sync_job/{connector_sync_job_id}/_check_in
Check in a connector sync job
connector-sync-job-check-in 1 param → 200
PUT
/_connector/_sync_job/{connector_sync_job_id}/_claim
Claim a connector sync job
connector-sync-job-claim 1 param body → 200
GET
/_connector/_sync_job/{connector_sync_job_id}
Get a connector sync job
connector-sync-job-get 1 param → 200
DELETE
/_connector/_sync_job/{connector_sync_job_id}
Delete a connector sync job
connector-sync-job-delete 1 param → 200
PUT
/_connector/_sync_job/{connector_sync_job_id}/_error
Set a connector sync job error
connector-sync-job-error 1 param body → 200
GET
/_connector/_sync_job
Get all connector sync jobs
connector-sync-job-list 5 params → 200
POST
/_connector/_sync_job
Create a connector sync job
connector-sync-job-post body → 200
PUT
/_connector/_sync_job/{connector_sync_job_id}/_stats
Set the connector sync job stats
connector-sync-job-update-stats 1 param body → 200
PUT
/_connector/{connector_id}/_filtering/_activate
Activate the connector draft filter
connector-update-active-filtering 1 param → 200
PUT
/_connector/{connector_id}/_api_key_id
Update the connector API key ID
connector-update-api-key-id 1 param body → 200
PUT
/_connector/{connector_id}/_configuration
Update the connector configuration
connector-update-configuration 1 param body → 200
PUT
/_connector/{connector_id}/_error
Update the connector error field
connector-update-error 1 param body → 200
PUT
/_connector/{connector_id}/_features
Update the connector features
connector-update-features 1 param body → 200
PUT
/_connector/{connector_id}/_filtering
Update the connector filtering
connector-update-filtering 1 param body → 200
PUT
/_connector/{connector_id}/_filtering/_validation
Update the connector draft filtering validation
connector-update-filtering-validation 1 param body → 200
PUT
/_connector/{connector_id}/_index_name
Update the connector index name
connector-update-index-name 1 param body → 200
PUT
/_connector/{connector_id}/_name
Update the connector name and description
connector-update-name 1 param body → 200
PUT
/_connector/{connector_id}/_native
Update the connector isnative flag
connector-update-native 1 param body → 200
PUT
/_connector/{connector_id}/_pipeline
Update the connector pipeline
connector-update-pipeline 1 param body → 200
PUT
/_connector/{connector_id}/_scheduling
Update the connector scheduling
connector-update-scheduling 1 param body → 200
PUT
/_connector/{connector_id}/_service_type
Update the connector service type
connector-update-service-type 1 param body → 200
PUT
/_connector/{connector_id}/_status
Update the connector status
connector-update-status 1 param body → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are connector._types.Connector (31 properties), connector._types.ConnectorSyncJob (18 properties), connector._types.ConnectorConfigProperties (15 properties), connector._types.SyncJobConnectorReference (8 properties). Each schema is shown below with its type and property counts.

connector._types.RegexValidation
object
2 properties 2 required
connector._types.ConnectorSyncJob
object
18 properties 11 required
connector._types.SyncJobTriggerMethod
string
connector._types.ConnectorFieldType
string
connector._types.SyncRulesFeature
object
2 properties
_types.ScalarValue
A scalar value.
connector._types.IngestPipelineParams
object
4 properties 4 required
_types.AcknowledgedResponseBase
object
1 property 1 required
_types.IndexName
string
_types.Id
string
connector._types.Connector
object
31 properties 8 required
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
connector._types.Validation
connector._types.FilteringRulesValidation
object
2 properties 2 required
_types.Result
string
connector._types.SyncJobType
string
_types.Names
_types.EpochTimeUnitMillis
connector._types.ConnectorScheduling
object
2 properties 2 required
connector._types.SyncJobConnectorReference
object
8 properties 5 required
connector._types.CustomScheduling
object
5 properties 4 required
connector._types.SchedulingConfiguration
object
3 properties
connector._types.ConnectorCustomScheduling
object
connector._types.FilteringValidation
object
2 properties 2 required
connector._types.CustomSchedulingConfigurationOverrides
object
5 properties
connector._types.FeatureEnabled
object
1 property 1 required
connector._types.IncludedInValidation
object
2 properties 2 required
connector._types.DisplayType
string
connector._types.FilteringConfig
object
3 properties 2 required
connector._types.FilteringPolicy
string
connector._types.LessThanValidation
object
2 properties 2 required
connector._types.ListTypeValidation
object
2 properties 2 required
_types.Indices
connector._types.FilteringRuleRule
string
connector._types.ConnectorConfiguration
object
_spec_utils.NullValue
stringnull
A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings…
connector._types.ConnectorConfigProperties
object
15 properties 8 required
connector._types.ConnectorStatus
string
_types.Metadata
object
connector._types.ConnectorFeatures
object
4 properties
connector._types.Dependency
object
2 properties 2 required
connector._types.FilteringValidationState
string
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
connector._types.FilteringRules
object
3 properties 3 required
connector._types.GreaterThanValidation
object
2 properties 2 required
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
connector._types.FilteringRule
object
8 properties 6 required
connector._types.SelectOption
object
2 properties 2 required
_types.Name
string
connector._types.FilteringAdvancedSnippet
object
3 properties 1 required
connector._types.SyncStatus
string
_types.UnitMillis
number
Time unit for milliseconds

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-connector-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
AE Profile APIs.io
Elastic Stack (ELK Stack) Accounts API
AE Profile APIs.io
Elastic Stack (ELK Stack) Actions API
AE Profile APIs.io
Elastic Stack (ELK Stack) agent builder API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting V2 API
AE Profile APIs.io
Elastic Stack (ELK Stack) Analytics API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent configuration API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent keys API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM annotations API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM server schema API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM sourcemaps API
AE Profile APIs.io
#Connector
← Back to E APIs
API Details
ID
elk-stack:elk-stack-connector-api
Base URL
https://{elasticsearch_endpoint}
Docs
https://www.elastic.co/docs/api/doc/elasticsearch/
Provider
Elastic Stack (ELK Stack)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elk-stack-connector-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elk-stack-connector-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Connector API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.