Create a snapshot repository for Elasticsearch resource

Base URL
https://api.elastic-cloud.com/api/v1
No auth
Important

This API is currently in Tech Preview. While available for use, it is subject to change. Creates a snapshot dependency, allowing this cluster to access snapshots from the source deployment. Currently unavailable in self-hosted ECE.

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)

Request body

The source deployment to link snapshots from

source_deployment_id string required

Source deployment ID whose snapshots will be accessible from the target cluster

Responses

The request was accepted and the configuration change will be processed asynchronously

application/json
message string required

Message indicating the request status

  • Cannot create a snapshot dependency from a deployment to itself. (code: deployments.snapshot_dependency_cannot_link_to_self)
  • Snapshot repository linking is not currently supported in this environment (e.g. self-hosted ECE). (code: deployments.snapshot_dependency_not_supported_in_env)
  • The request failed validation. (code: clusters.cluster_invalid_plan)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

  • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
  • The source deployment cannot be found. (code: deployments.snapshot_dependency_source_not_found)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Failed to create snapshot dependency. (code: deployments.snapshot_dependency_internal_error)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Base URL
https://api.elastic-cloud.com/api/v1