Get allocator metadata

GET /platform/infrastructure/allocators/{allocator_id}/metadata

Retrieves the allocator metadata.

Path parameters

Responses

  • The allocator metadata was successfully returned

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • key string Required

      The metadata field name

    • value string Required

      The metadata value

  • The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is allocators.allocator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

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

GET /platform/infrastructure/allocators/{allocator_id}/metadata
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
[
  {
    "key": "string",
    "value": "string"
  }
]
Response examples (404)
# Headers
x-cloud-error-codes: allocators.allocator_not_found

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