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.

« Search allocators Get allocator »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.3] ›RESTful API ›API reference ›Platform - Allocators

Delete allocator

edit

Delete allocator

edit

Deletes the allocator.

Request

edit

DELETE /api/v1/platform/infrastructure/allocators/{allocator_id}

Path parameters

edit
Name Type Required Description

allocator_id

string

Y

The allocator identifier.

Query parameters

edit
Name Type Required Description

remove_instances

boolean; default: false

N

Removes the instances from the deleted allocator.

Responses

edit
200

(EmptyResponse) The allocator specified by {allocator_id} was successfully deleted

400

(BasicFailedReply) * The allocator specified by {allocator_id} could not be deleted. (code: allocators.delete_connected_allocator_attempt) * The allocator specified by {allocator_id} could not be deleted. (code: allocators.delete_allocator_with_instances_attempt)

404

(BasicFailedReply) The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

449

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

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/infrastructure/allocators/{allocator_id} \
-u $CLOUD_USER:$CLOUD_KEY
« Search allocators Get allocator »