Elastic Stack

Elastic Stack (ELK Stack) Ccr API

The ccr API from Elastic Stack (ELK Stack) — 12 operation(s) for ccr.

GitHub OpenAPI

Operations 14

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 /_ccr/auto_follow/{name} View one auto-follow pattern · Get auto-follow patterns #
Ask an LLM
“What settings does a specific cross-cluster replication auto-follow pattern use?”
“Can I look up a single auto-follow pattern by its name to see which leader indices it matches?”
Tell an agent
Show me the auto-follow pattern named {name}.
Get the leader index patterns configured in auto-follow pattern {name}.
PUT /_ccr/auto_follow/{name} Create or update an auto-follow pattern · Create or update auto-follow patterns #
Ask an LLM
“How do I automatically replicate new indices from a remote cluster as they get created?”
“Can I exclude some leader indices from an auto-follow pattern while matching the rest?”
Tell an agent
Create auto-follow pattern {name} that follows indices matching {leader_index_patterns} on remote cluster {remote_cluster}.
Set up auto-following called {name} from {remote_cluster}, naming followers with the pattern {follow_index_pattern}.
DELETE /_ccr/auto_follow/{name} Delete an auto-follow pattern · Delete auto-follow patterns #
Ask an LLM
“How do I remove an auto-follow pattern I no longer need for cross-cluster replication?”
“Will deleting an auto-follow pattern stop replication for follower indices it already created?”
Tell an agent destructive · confirm first
Delete the auto-follow pattern {name}.
Remove auto-follow collection {name} from this cluster permanently.
PUT /{index}/_ccr/follow Create a follower index for a leader index · Create a follower #
Ask an LLM
“How do I start replicating one specific index from a remote Elasticsearch cluster?”
“Can I wait until the follower index shards are active before the follow request returns?”
Tell an agent
Create follower index {index} that replicates leader index {leader_index} from remote cluster {remote_cluster}.
Make {index} follow {leader_index} on {remote_cluster} and wait for {wait_for_active_shards} active shards.
GET /{index}/_ccr/info Get follower index configuration and status · Get follower information #
Ask an LLM
“Is my follower index currently active or paused, and which leader does it track?”
“Where can I see the replication parameters a follower index was created with?”
Tell an agent
Show the follower configuration and status for {index}.
Tell me whether follower index {index} is active or paused.
GET /{index}/_ccr/stats Get shard-level stats for a follower index · Get follower stats #
Ask an LLM
“How far behind the leader is my follower index on each shard?”
“Which shard-level following-task metrics are reported for a replicated index?”
Tell an agent
Get shard-level replication stats for follower index {index}.
Report the following-task stats for {index}, timing out after {timeout}.
POST /{index}/_ccr/forget_follower Remove follower retention leases from a leader · Forget a follower #
Ask an LLM
“How do I clean up retention leases a follower left on the leader index after unfollowing failed?”
“Why is my leader index still holding history for a follower I already removed?”
Tell an agent destructive · confirm first
On leader index {index}, remove the retention leases held by follower {follower_index} in cluster {follower_cluster}.
Forget follower index UUID {follower_index_uuid} on leader {index}.
GET /_ccr/auto_follow List all auto-follow patterns · Get auto-follow patterns #
Ask an LLM
“Which auto-follow patterns are configured on this cluster?”
“Can I see every cross-cluster replication auto-follow collection at once?”
Tell an agent
List all auto-follow patterns on the cluster.
Show every configured auto-follow pattern, waiting up to {master_timeout} for the master node.
POST /_ccr/auto_follow/{name}/pause Pause an auto-follow pattern · Pause an auto-follow pattern #
Ask an LLM
“How do I temporarily stop an auto-follow pattern from creating new follower indices?”
“Do followers that an auto-follow pattern already created keep replicating after I pause it?”
Tell an agent
Pause auto-follow pattern {name}.
Stop auto-follow pattern {name} from following new leader indices for now.
POST /{index}/_ccr/pause_follow Pause a follower index · Pause a follower #
Ask an LLM
“How do I temporarily stop a follower index from fetching operations from its leader?”
“Can I pause replication on one follower index before changing its settings?”
Tell an agent
Pause replication on follower index {index}.
Halt fetching from the leader for follower {index} so I can reconfigure it.
POST /_ccr/auto_follow/{name}/resume Resume a paused auto-follow pattern · Resume an auto-follow pattern #
Ask an LLM
“How do I turn a paused auto-follow pattern back on?”
“Will a resumed auto-follow pattern start creating followers for newly matching remote indices again?”
Tell an agent
Resume auto-follow pattern {name}.
Reactivate the paused auto-follow collection {name}.
POST /{index}/_ccr/resume_follow Resume a paused follower index · Resume a follower #
Ask an LLM
“How do I restart replication on a follower index that I paused?”
“Can I change read and write buffer limits when resuming a follower?”
Tell an agent
Resume following on follower index {index}.
Restart replication for {index} with a read poll timeout of {read_poll_timeout}.
GET /_ccr/stats Get cluster-wide cross-cluster replication stats · Get cross-cluster replication stats #
Ask an LLM
“What are the overall cross-cluster replication stats, including auto-follow results?”
“Have any auto-follow attempts failed recently on this cluster?”
Tell an agent
Show cross-cluster replication stats for the whole cluster.
Get auto-following and follower stats, timing out after {timeout}.
POST /{index}/_ccr/unfollow Convert a follower into a regular index · Unfollow an index #
Ask an LLM
“How do I turn a follower index into a normal standalone index?”
“Does an index need to be paused and closed before I can stop it following its leader?”
Tell an agent destructive · confirm first
Unfollow {index} and convert it to a regular index.
Permanently stop follower {index} from tracking its leader.

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-ccr-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-ccr-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-ccr-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Ccr API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:


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