Machine

Retrieve Machine label keys

Changed on

Retrieve paginated, unique, non-null Machine label keys. Results are ordered by key ascending by default before pagination.

Infrastructure Provider callers receive keys from their Provider's Machines. Tenant Admin callers receive keys only from Sites where TargetedInstanceCreation is effective. For organizations with both roles, Provider scope takes precedence, so privileged Tenant Sites owned by other Providers are excluded. The optional siteId parameter further restricts the result.

get/v2/org/{org}/nico/machine/label/key

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/machine/label/key
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

ID of the Site to filter label keys by

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'KEY_ASC' | 'KEY_DESC'

Ordering applied before pagination; defaults to KEY_ASC

Response

OK

string[] required

Example response

[
  "failure-domain",
  "power-domain"
]

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status