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

Delete allocator metadata item

edit

Delete allocator metadata item

edit

Removes a single item from the allocator 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.

Query parameters

edit
Name Type Required Description

version

string

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)

Headers

x-cloud-error-codes (string; allowed values: [allocators.allocator_not_found])
The error codes associated with the response

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Set allocator metadata Set allocator metadata item »