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.
Delete allocator metadata item
editDelete allocator metadata item
editRemoves a single item from the allocator metadata.
Request
editDELETE /api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The allocator identifier. |
|
|
Y |
The metadata item key. |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
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
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XDELETE {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key} \
-H "Authorization: ApiKey $ECE_API_KEY"