Set allocator metadata item
editSet allocator metadata item
editAdds or updates a single item in the allocator metadata.
Request
editPUT /api/v1/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
|
|
Y |
The metadata item key. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
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
-
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
-
-
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
-
The allocator specified by {allocator_id} cannot be found. (code:
Request example
editcurl -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" } '