Set allocator metadata itemedit
Adds or updates a single item in the allocator metadata.
Requestedit
PUT /api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
|
|
Y |
The metadata item key. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request bodyedit
(MetadataItemValue
) (required) The value of the metadata item to add or update
Responsesedit
-
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
) -
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
) -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)
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/{key} \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "value" : "string" } '