Set allocator metadata

Sets the allocator metadata.

Request

PUT /api/v1/platform/infrastructure/allocators/{allocator_id}/metadata

Path parameters

Name Type Required Description

allocator_id

string

Y

The allocator identifier.

Query parameters

Name Type Required Description

version

integer

N

Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Request body

(MetadataItems) (required) The metadata to update the allocator with

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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