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 metadataedit
Sets the metadata for a given allocator.
Requestedit
PUT /api/v1/platform/infrastructure/allocators/{allocator_id}/metadata
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request bodyedit
(MetadataItems
) (required) The metadata to update the allocator with
Responsesedit
-
200
-
(
array[
MetadataItem
]
) The allocator metadata was successfully changed (the updated JSON is returned) -
400
-
(
BasicFailedReply
) The value specified is empty for at least one of the metadata tags (code: 'allocators.invalid_empty_metadata_items') -
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 exampleedit
curl -XPUT {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "items" : [ { "key" : "string", "value" : "string" } ] } '