Deployment Resources - CRUD

Restores a shutdown resource

Restores a shutdown resource belonging to a given Deployment.

Request

POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

resource_kind

string; allowed values: [elasticsearch, kibana, apm, appsearch]

Y

The kind of resource

Query parameters

NameTypeRequiredDescription

restore_snapshot

boolean; default: false

N

Whether or not to restore a snapshot for those resources that allow it.

Responses

200
(DeploymentResourceCrudResponse) Standard Deployment Resource Crud Response
400

(BasicFailedReply) The resource is not shut down. (code: deployments.resource_not_shutdown)

Headers

x-cloud-error-codes (string; allowed values: [deployments.resource_not_shutdown])
The error codes associated with the response
404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

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

Request example

curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Set a Deployment’s resource metadata

Advanced use only. Sets the internal metadata, in free-form JSON, for the resource. Only use the parameter to set the modified JSON that is returned from the get version of the metadata.

Request

POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

resource_kind

string; allowed values: [elasticsearch, kibana, apm, appsearch]

Y

The kind of resource

Query parameters

NameTypeRequiredDescription

version

integer

N

If specified, checks for conflicts against the metadata version (returned in 'x-cloud-resource-version' of the GET request)

Request body

(string) (required) The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)

Responses

200

(string) The resource metadata was successfully changed (the updated JSON is returned)

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
400

(BasicFailedReply) The metadata is invalid. (code: deployments.invalid_metadata)

Headers

x-cloud-error-codes (string; allowed values: [deployments.invalid_metadata])
The error codes associated with the response
404

(BasicFailedReply) A resource with the given refId cannot be found in the deployment. (code: deployments.deployment_resource_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response
500

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

Headers

x-cloud-error-codes (string; allowed values: [deployments.metadata_internal_error])
The error codes associated with the response

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

Request example

curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Cancel resource pending plan

Cancels the pending plan of a Resource belonging to a given Deployment.

Request

DELETE /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

resource_kind

string; allowed values: [elasticsearch, kibana, apm, appsearch]

Y

The kind of resource

Query parameters

NameTypeRequiredDescription

force_delete

boolean; default: false

N

When true, deletes the pending plan instead of attempting a graceful cancellation. The default is false.

ignore_missing

boolean; default: false

N

When true, returns successfully, even when plans are missing. The default is false.

Responses

200
(DeploymentResourceCrudResponse) Standard Deployment Resource Crud Response
400

(BasicFailedReply) The Resource does not have a pending plan. (code: deployments.resource_does_not_have_a_pending_plan)

Headers

x-cloud-error-codes (string; allowed values: [deployments.resource_does_not_have_a_pending_plan])
The error codes associated with the response
404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response
500

(BasicFailedReply) We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists])
The error codes associated with the response

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/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Delete Stateless Resource from Deployment

Delete Stateless Resource belonging to a given Deployment. Deployment must be shutdown already.

Request

DELETE /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

stateless_resource_kind

string; allowed values: [kibana, apm, appsearch]

Y

The kind of stateless resource

Responses

200
(DeploymentResourceCrudResponse) Standard Deployment Resource Crud Response
400

(BasicFailedReply) Resource has still instances. (code: deployments.resource_has_instances)

Headers

x-cloud-error-codes (string; allowed values: [deployments.resource_has_instances])
The error codes associated with the response
404

(BasicFailedReply) A resource with the given refId cannot be found in the deployment. (code: deployments.deployment_resource_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response
500

(BasicFailedReply) We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists])
The error codes associated with the response

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/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id} \
-H "Authorization: ApiKey $CLOUD_API_KEY"