« Deployment - Upgrade Assistant Deployments - Extensions »
Elastic Docs ›Elasticsearch Service Documentation ›RESTful API ›API reference documentation

Deployment Resources - CRUD

edit

Deployment Resources - CRUD

edit

Get the items in the Elasticsearch resource keystore

edit

Fetches the current fields and metadata (but not the values) of the keystore for the Elasticsearch resource.

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource (or '_main' if there is only one)

Responses

edit
200

(KeystoreContents)

The contents of the Elasticsearch keystore, with values redacted

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
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

Request example

edit
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 items from the Elasticsearch resource keystore

edit

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

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource (or '_main' if there is only one)

Request body

edit

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

Responses

edit
200

(KeystoreContents)

The new contents of the Elasticsearch keystore

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
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

Request example

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

Restores a shutdown resource

edit

Restores a shutdown resource belonging to a given Deployment.

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource (or '_main' if there is only one)

resource_kind

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

Y

The kind of resource

Query parameters

edit
Name Type Required Description

restore_snapshot

boolean; default: false

N

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

Responses

edit
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

Request example

edit
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 plan

edit

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

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource (or '_main' if there is only one)

resource_kind

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

Y

The kind of resource

Query parameters

edit
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.

Responses

edit
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
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

Request example

edit
curl -XDELETE https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending \
-H "Authorization: ApiKey $EC_API_KEY"
« Deployment - Upgrade Assistant Deployments - Extensions »