Set allocator metadata item

PUT /platform/infrastructure/allocators/{allocator_id}/metadata/{key}

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[]

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

application/json

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

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/platform/infrastructure/allocators/${ALLOCATOR_ID}/metadata/${KEY}" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "string"
  }'

Generated from the API spec

Response

[
  {
    "key": "string",
    "value": "string"
  }
]

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec