Set snapshot repository

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

Creates or updates the snapshot repository configuration.

Path parameters

Query parameters

  • version integer

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

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

    Additional properties are allowed.

Responses

  • 200

    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

      Additional properties are allowed.
PUT /platform/configuration/snapshots/repositories/{repository_name} 
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
 -d '{"type":"string","settings":{}}'
Request examples 
{
  "type": "string",
  "settings": {}
}
Response examples (200) 
{
  "repository_name": "string",
  "config": {}
}