Set allocator metadataedit
Sets the allocator metadata.
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)Headers
-
x-cloud-error-codes(string; allowed values: [allocators.invalid_empty_metadata_items]) - The error codes associated with the response
-
-
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
-
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
"items" : [
{
"key" : "string",
"value" : "string"
}
]
}
'