It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Create instance configuration Get instance configuration »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Platform - Configuration - Instances - CRUD

Delete a instance configuration

edit

Delete a instance configuration

edit

Delete the instance configuration with the given id

Request

edit

DELETE /api/v1/platform/configuration/instances/{id}

Path parameters

edit
Name Type Required Description

id

string

Y

ID of the instance configuration

Query parameters

edit
Name Type Required Description

version

integer

N

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

Responses

edit
200

(EmptyResponse) Instance configuration specified by {id} was deleted

403

(BasicFailedReply) Instance configuration specified by {id} is system owned (code: 'configuration.system_owned')

404

(BasicFailedReply) Instance configuration specified by {id} cannot be found or the operation failed (code: 'configuration.instance_configuration_not_found')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')

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

Request example

edit
curl -XDELETE {{hostname}}/api/v1/platform/configuration/instances/{id} \
-u $CLOUD_USER:$CLOUD_KEY
« Create instance configuration Get instance configuration »