Set snapshot repository

PUT /platform/configuration/snapshots/repositories/{repository_name}

Auth

Creates or updates the snapshot repository configuration.

Path parameters

repository_name string required: The name of the snapshot repository configuration.

Query parameters

version integer: Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Request body

The Elasticsearch snapshot repository configuration

type string required: Repository type, (Currently supported: 's3')
settings object required: Elasticsearch repository configuration settings JSON. See Elasticsearch documentation for more information

Response

New snapshot repository config

application/octet-stream

repository_name string required: Elasticsearch snapshot repository name
config object required: Elasticsearch configuration JSON for a snapshot repository

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/platform/configuration/snapshots/repositories/${REPOSITORY_NAME}" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "settings": {}
  }'

Generated from the API spec

Response

No example

Path parameters

Query parameters

Request body { }

Response

Request body