IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete allocator metadata item Get allocator settings »

› › › ›

Set allocator metadata item

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Set allocator metadata item

edit

Adds or updates a single item in the allocator metadata.

Request

edit

PUT /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.

Request body

edit

(MetadataItemValue) (required) The value of the metadata item to add or update

Responses

edit

200

(array[MetadataItem])

The allocator metadata was successfully changed (the updated JSON is returned)

400

(BasicFailedReply)

The value specified for the metadata tag is empty. (code: allocators.invalid_empty_metadata_item)

Headers

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

404

(BasicFailedReply)

The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)
The metadata item specified by {key} cannot be found. (code: allocators.metadata_item_not_found)

Headers

x-cloud-error-codes (string; allowed values: [allocators.allocator_not_found, allocators.metadata_item_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

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "value" : "string"
}
'

« Delete allocator metadata item Get allocator settings »