Docs
Elastic Cloud Enterprise Reference [2.4] » RESTful API » API reference » Platform - Repository - CRUD
« Platform - License Platform - Runners »

Platform - Repository - CRUD

Get snapshot repositories

Retrieves a list of available snapshot repository configurations. To access the configuration contents, you must have privileged permissions.

Request

GET /api/v1/platform/configuration/snapshots/repositories

Responses

200

(RepositoryConfigs) List of snapshot repository configs

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/snapshots/repositories \
-H "Authorization: ApiKey $ECE_API_KEY"

Delete snapshot repository

Deletes the snapshot repository configuration.

Request

DELETE /api/v1/platform/configuration/snapshots/repositories/{repository_name}

Path parameters

Name Type Required Description

repository_name

string

Y

The name of the snapshot repository configuration.

Responses

200

(EmptyResponse) successful operation

202

(EmptyResponse) Delete snapshot repository config

449

(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-H "Authorization: ApiKey $ECE_API_KEY"

Get snapshot repository

Retrieves the snapshot repository configuration. To access the configuration contents, you must have privileged permissions.

Request

GET /api/v1/platform/configuration/snapshots/repositories/{repository_name}

Path parameters

Name Type Required Description

repository_name

string

Y

The name of the snapshot repository configuration.

Responses

200

(RepositoryConfig) Retrieve snapshot repository config

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-H "Authorization: ApiKey $ECE_API_KEY"

Set snapshot repository

Creates or updates the snapshot repository configuration.

Request

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

Path parameters

Name Type Required Description

repository_name

string

Y

The name of the snapshot repository configuration.

Query parameters

Name Type Required Description

version

integer

N

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

Request body

(SnapshotRepositoryConfiguration) (required) The Elasticsearch snapshot repository configuration

Responses

200

(RepositoryConfig) New snapshot repository config

449

(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/configuration/snapshots/repositories/{repository_name} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "settings" : {},
   "type" : "string"
}
'
« Platform - License Platform - Runners »