Delete Stateless Resource from Deployment

edit

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

Request

edit

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

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)

stateless_resource_kind

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

Y

The kind of stateless resource

Responses

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

  • 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.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://{{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id} \
-H "Authorization: ApiKey $ECE_API_KEY"