Remove the attached snapshot repository

DELETE /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}

Auth

Removes the attached snapshot repository. This is only possible if the repository is not in use anymore by any searchable snapshots.

Path parameters

deployment_id string required: Identifier for the Deployment
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one)
repository_name string required: The name of the snapshot repository to remove (e.g. _clone_abcd1234)

Responses

application/json

Response Type: object

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
The snapshot repository specified by {repository_name} cannot be found. (code: deployments.snapshot_dependency_not_found)

application/json

We have failed you. (code: deployments.metadata_internal_error)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X DELETE "${API_URL}/deployments/${DEPLOYMENT_ID}/elasticsearch/${REF_ID}/snapshot/repository/${REPOSITORY_NAME}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec