Set snapshot repository

PUT /platform/configuration/snapshots/repositories/{repository_name}
Basic auth Api key

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.

application/json

Body Required

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

Responses

  • 200 application/json

    New snapshot repository config

    Hide response attributes Show response attributes object
    • repository_name string Required

      Elasticsearch snapshot repository name

    • config object Required

      Elasticsearch configuration JSON for a snapshot repository
PUT /platform/configuration/snapshots/repositories/{repository_name} 
curl \
 --request PUT 'https://{{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name}' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"type":"string","settings":{}}'