> ## Documentation Index
> Fetch the complete documentation index at: https://docs.internal.nscale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List all topology group labels

> Return one site's topology-group labels, unpaginated and naturally ordered.

Labels rather than ids, because the label is what a caller filters with: the
requirement-verdicts endpoints match `pod_id` against a pod's topology label
and report it as the row's `target_id`, so no consumer ever holds a group's
primary key. That key is not durable either — `rebuild` replaces a site+facet
slice with fresh ones — while a label is unique within a site and facet, so it
is a stable option key as well as the filter value. Across facets it is not:
an unfiltered read of a site carrying the same label in two facets returns it
once per facet, which `?type=pod` cannot reach because the power facet admits
no pods.

Narrow to one tier with the shared `type` filter; `?type=pod` is the pod set
the Requirements-verdicts filter is built from. Natural ordering matches the
order that endpoint applies to its own `pod_ids`, so the filter list and the
rows it filters agree.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/topology-groups/list-all-labels/
openapi: 3.0.3
info:
  title: Fleet Manager API
  version: 1.0.0
  description: API for the Nscale Fleet Manager
servers: []
security: []
paths:
  /api/v1/topology-groups/list-all-labels/:
    get:
      tags:
        - Topology Groups
      summary: List all topology group labels
      description: >-
        Return one site's topology-group labels, unpaginated and naturally
        ordered.


        Labels rather than ids, because the label is what a caller filters with:
        the

        requirement-verdicts endpoints match `pod_id` against a pod's topology
        label

        and report it as the row's `target_id`, so no consumer ever holds a
        group's

        primary key. That key is not durable either — `rebuild` replaces a
        site+facet

        slice with fresh ones — while a label is unique within a site and facet,
        so it

        is a stable option key as well as the filter value. Across facets it is
        not:

        an unfiltered read of a site carrying the same label in two facets
        returns it

        once per facet, which `?type=pod` cannot reach because the power facet
        admits

        no pods.


        Narrow to one tier with the shared `type` filter; `?type=pod` is the pod
        set

        the Requirements-verdicts filter is built from. Natural ordering matches
        the

        order that endpoint applies to its own `pod_ids`, so the filter list and
        the

        rows it filters agree.
      operationId: api_v1_topology_groups_list_all_labels_retrieve
      parameters:
        - in: query
          name: ancestor_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - name: annotation_eq
          required: false
          in: query
          description: >-
            Filter by annotation key=value pairs (AND semantics). Use
            annotation_eq[key]=value.
          style: deepObject
          explode: true
          schema:
            type: object
            additionalProperties:
              type: string
        - name: annotation_has
          required: false
          in: query
          description: Filter by annotation key existence (comma-separated, AND semantics).
          schema:
            type: string
        - in: query
          name: facet
          schema:
            $ref: '#/components/schemas/FacetEnum'
          description: Optional. Keep only groups in this topology facet.
        - in: query
          name: label
          schema:
            type: string
        - in: query
          name: parent_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: site_id
          schema:
            type: string
            format: uuid
          description: Site ID used to constrain the unpaginated compact response.
          required: true
        - name: tag
          required: false
          in: query
          description: Filter by tags (comma-separated, OR semantics).
          schema:
            type: string
        - in: query
          name: top_level
          schema:
            type: boolean
        - in: query
          name: type
          schema:
            $ref: '#/components/schemas/TopologyGroupTypeEnum'
          description: Optional. Keep only groups of this tier; `pod` is the pod set.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: ''
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - topology-group:read
        - cookieAuth: []
components:
  schemas:
    FacetEnum:
      enum:
        - networking
        - power
      type: string
      description: |-
        * `networking` - networking
        * `power` - power
    TopologyGroupTypeEnum:
      enum:
        - root
        - super-spine
        - spine
        - pod
        - nvlink-domain
        - unknown
      type: string
      description: >-
        * `root` - root

        * `super-spine` - super-spine groups multiple spines together

        * `spine` - spine groups multiple pods together

        * `pod` - pod groups either multiple devices or multiple nvlink-domains
        together

        * `nvlink-domain` - nvlink-domain groups multiple devices together (min:
        1)

        * `unknown` - unknown
    ErrorResponse:
      type: object
      description: >-
        Uniform error body for every 4xx/5xx response. `detail` is a
        human-readable message, always present, safe to display to end users.
        `code` is the machine-readable identifier. `field_errors` lists
        per-input-field validation messages and is empty for non-field errors
        (auth, permission, not-found, conflict, server).
      required:
        - detail
        - code
        - field_errors
      properties:
        detail:
          type: string
        code:
          $ref: '#/components/schemas/ErrorCodeEnum'
        field_errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    ErrorCodeEnum:
      type: string
      description: >-
        Stable machine-readable error identifier. New members may be added
        within this API version; clients must tolerate unknown values.
      enum:
        - error
        - invalid
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - conflict
        - enrollment_infrastructure_reference_pending
        - enrollment_infrastructure_reference_changed
        - unprocessable_entity
        - throttled
        - service_unavailable
    FieldError:
      type: object
      description: One input field's validation messages.
      required:
        - field
        - messages
      properties:
        field:
          type: string
          description: >-
            Dotted path to the offending input field, or to the collection row
            when the whole row is invalid (e.g. `filters.end_date`,
            `memberships.0.role`, `memberships.0`).
        messages:
          type: array
          minItems: 1
          items:
            type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.