Deployment Resources - CRUDedit

Get the settings from the Elasticsearch resource keystoreedit

Adds the specified values to the Elasticsearch keystore, or removes the keys for the unspecified values.

Requestedit

GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Responsesedit

200

(KeystoreContents) The new value for the keystore contents

404

(BasicFailedReply) * 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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, 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 exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore \
-H "Authorization: ApiKey $EC_API_KEY"

Add or remove settings from the Elasticsearch resource keystoreedit

Fetches the current values of the keystore for the Elasticsearch resource.

Requestedit

PATCH /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Request bodyedit

(KeystoreContents) (required) The new settings that will be applied to the keystore of the Elasticsearch resource.

Responsesedit

200

(KeystoreContents) The new value for the keystore contents

404

(BasicFailedReply) * 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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, 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 exampleedit

curl -XPATCH https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "secrets" : {
      "some_property" : {
         "as_file" : true,
         "value" : {}
      }
   }
}
'

Restores a shutdown resourceedit

Restores a shutdown resource belonging to a given Deployment.

Requestedit

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

Path parametersedit

Name Type Required Description

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, enterprise_search]

Y

The kind of resource

Query parametersedit

Name Type Required Description

restore_snapshot

boolean; default: false

N

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

Responsesedit

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) * The resource is not shut down. (code: deployments.resource_not_shutdown)

Headers

x-cloud-error-codes (string; allowed values: [deployments.resource_does_not_have_a_pending_plan, 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 exampleedit

curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore \
-H "Authorization: ApiKey $EC_API_KEY"

Cancel resource pending planedit

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

Requestedit

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

Path parametersedit

Name Type Required Description

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, enterprise_search]

Y

The kind of resource

Query parametersedit

Name Type Required Description

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.

Responsesedit

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 exampleedit

curl -XDELETE https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending \
-H "Authorization: ApiKey $EC_API_KEY"