Resume an auto-follow pattern

POST /_ccr/auto_follow/{name}/resume

Auth

Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.

More about auto-follow patterns

Required authorization

Cluster privileges manage_ccr

Path parameters

name string required: The name of the auto-follow pattern to resume.

Query parameters

master_timeout string · default: 30s: The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_ccr/auto_follow/my_auto_follow_pattern/resume

JavaScript Elasticsearch JavaScript Client

const response = await client.ccr.resumeAutoFollowPattern({
  name: "my_auto_follow_pattern",
});

Python Elasticsearch Python Client

resp = client.ccr.resume_auto_follow_pattern(
    name="my_auto_follow_pattern",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ccr/auto_follow/my_auto_follow_pattern/resume" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ccr().resumeAutoFollowPattern(r -> r
    .name("my_auto_follow_pattern")
);

C# Elasticsearch .NET Client

var response = await client.CrossClusterReplication.ResumeAutoFollowPatternAsync(name: "my_auto_follow_pattern");

PHP Elasticsearch PHP Client

$resp = $client->ccr()->resumeAutoFollowPattern([
    "name" => "my_auto_follow_pattern",
]);

Ruby Elasticsearch Ruby Client

response = client.ccr.resume_auto_follow_pattern(
  name: "my_auto_follow_pattern"
)

Response

A successful response POST /_ccr/auto_follow/my_auto_follow_pattern/resume, which resumes an auto-follow pattern.

{
  "acknowledged" : true
}