Create or update a snapshot repository

POST also PUT /_snapshot/{repository}

IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access.

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used.

Required authorization

Cluster privileges: manage

Read the reference documentation

Path Parameters

repository string Name required: The name of the snapshot repository to register or update.

Query Parameters

Request

Response

application/json

Examples

Run POST /_snapshot/my_repository to create or update a shared file system snapshot repository.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_snapshot/my_repository
{
  "type": "fs",
  "settings": {
    "location": "my_backup_location"
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.createRepository({
  name: "my_repository",
  repository: {
    type: "fs",
    settings: {
      location: "my_backup_location",
    },
  },
});

Python Elasticsearch Python Client

resp = client.snapshot.create_repository(
    name="my_repository",
    repository={
        "type": "fs",
        "settings": {
            "location": "my_backup_location"
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "fs",
    "settings": {
      "location": "my_backup_location"
    }
  }'

Java Elasticsearch Java Client

client.snapshot().createRepository(c -> c
    .name("my_repository")
    .repository(r -> r
        .fs(f -> f
            .settings(s -> s
                .location("my_backup_location")
            )
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Snapshot
    .CreateRepositoryAsync(name: "my_repository", d1 => d1
        .Repository(new SharedFileSystemRepository()
        {
            Settings = new()
            {
                Location = "my_backup_location"
            }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->createRepository([
    "repository" => "my_repository",
    "body" => [
        "type" => "fs",
        "settings" => [
            "location" => "my_backup_location",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.snapshot.create_repository(
  repository: "my_repository",
  body: {
    "type": "fs",
    "settings": {
      "location": "my_backup_location"
    }
  }
)

Response

No example

Run POST /_snapshot/my_repository to create or update an Azure snapshot repository.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /_snapshot/my_repository
{
  "type": "azure",
  "settings": {
    "client": "secondary"
  }
}

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "azure",
  "settings": {
    "client": "secondary"
  }
}'

Response

No example

Run POST /_snapshot/my_gcs_repository to create or update a Google Cloud Storage snapshot repository.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /_snapshot/my_gcs_repository
{
  "type": "gcs",
  "settings": {
    "bucket": "my_other_bucket",
    "base_path": "dev"
  }
}

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_gcs_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "gcs",
  "settings": {
    "bucket": "my_other_bucket",
    "base_path": "dev"
  }
}'

Response

No example

Run POST /_snapshot/my_s3_repository to create or update an AWS S3 snapshot repository.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /_snapshot/my_s3_repository
{
  "type": "s3",
  "settings": {
    "bucket": "my-bucket"
  }
}

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_s3_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "s3",
  "settings": {
    "bucket": "my-bucket"
  }
}'

Response

No example

Run POST _snapshot/my_src_only_repository to create or update a source-only snapshot repository.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST _snapshot/my_src_only_repository
{
  "type": "source",
  "settings": {
    "delegate_type": "fs",
    "location": "my_backup_repository"
  }
}

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_src_only_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "source",
  "settings": {
    "delegate_type": "fs",
    "location": "my_backup_repository"
  }
}'

Response

No example

Run POST _snapshot/my_read_only_url_repository to create or update a read-only URL snapshot repository.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST _snapshot/my_read_only_url_repository
{
  "type": "url",
  "settings": {
    "url": "file:/mount/backups/my_fs_backup_location"
  }
}

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_read_only_url_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "url",
  "settings": {
    "url": "file:/mount/backups/my_fs_backup_location"
  }
}'

Response

No example

Required authorization

Path Parameters

Query Parameters { master_timeout , timeout , verify , }

Request AzureRepository | GcsRepository | S3Repository | SharedFileSystemRepository | ReadOnlyUrlRepository | SourceOnlyRepository |

Response

Query Parameters

Request