Set allocator metadata item

Auth

Adds or updates a single item in the allocator metadata.

Path parameters

allocator_id string required

The allocator identifier.

key string required

The metadata item key.

Query parameters

version string

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

Request body

The value of the metadata item to add or update

value string required

The metadata value

Responses

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

application/json
<array> object[]
key string required

The metadata field name

value string required

The metadata value

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

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

  • 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)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response