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.

« Set allocator metadata Set allocator metadata item »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Platform - Allocators

Delete allocator metadata item

edit

Delete allocator metadata item

edit

Removes a single item from a given allocators metadata.

Request

edit

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

Path parameters

edit
Name Type Required Description

allocator_id

string

Y

The allocator identifier.

key

string

Y

The metadata item key to remove.

Query parameters

edit
Name Type Required Description

version

integer

N

Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Responses

edit
200

(array[MetadataItem]) The allocator metadata was successfully changed (the updated JSON is returned)

404

(BasicFailedReply) The allocator specified by {allocator_id} cannot be found (code: 'allocators.allocator_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/infrastructure/allocators/{allocator_id}/metadata/{key} \
-u $CLOUD_USER:$CLOUD_KEY
« Set allocator metadata Set allocator metadata item »