> ## 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 burn-in test catalogue

> Endpoint exposing burn-in test catalogue definitions.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/burn-in/sites/{site_id}/tests/
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/burn-in/sites/{site_id}/tests/:
    get:
      tags:
        - Burn-in
      summary: List burn-in test catalogue
      description: Endpoint exposing burn-in test catalogue definitions.
      operationId: api_v1_burn_in_site_tests_list
      parameters:
        - in: query
          name: include
          schema:
            $ref: '#/components/schemas/TestCatalogueIncludeEnum'
          description: Use include=all to return the full displayable catalogue.
        - in: query
          name: resource_class
          schema:
            type: string
          description: >-
            Select the resource-class-specific policy and threshold context.
            Required for filtered catalogue requests when a site has multiple
            policy-backed resource classes.
        - in: path
          name: site_id
          schema:
            type: string
            format: uuid
          description: Site identifier.
          required: true
        - in: query
          name: stage
          schema:
            type: array
            items:
              $ref: '#/components/schemas/StageEnum'
          description: >-
            Filter by one or more test stages. Accepts a comma-separated list
            (`stage=single_node,pairwise`) or a repeated parameter
            (`stage=single_node&stage=pairwise`).
          explode: false
          style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestCatalogueResponse'
              examples:
                TestCatalogueExample:
                  value:
                    single-node.hpl-gpu:
                      slug: single-node.hpl-gpu
                      stage: single_node
                      name: HPL GPU
                      threshold_status: configured
                      metrics:
                        - key: gflops
                          type: MetricValue
                          label: Performance (GFLOPS)
                          unit: GFLOPS
                          threshold:
                            value: 340000
                            comparator: gte
                            statistic: mean
                        - key: execution_time_seconds
                          type: MetricValue
                          label: Execution Time (s)
                          unit: s
                          threshold: null
                        - key: gflops_per_gpu
                          type: MetricValue
                          label: Performance/GPU (GFLOPS)
                          optional: true
                          unit: GFLOPS
                          threshold: null
                      acceptance_gates:
                        - single_node_acceptance
                    multi-node.nccl-all-reduce:
                      slug: multi-node.nccl-all-reduce
                      stage: collective
                      name: NCCL All Reduce
                      threshold_status: configured
                      metrics:
                        - key: last_busbw_gbps
                          type: MetricValue
                          label: Bus BW (GB/s)
                          unit: GB/s
                          threshold:
                            value: 340
                            comparator: gte
                            statistic: null
                        - key: last_algbw_gbps
                          type: MetricValue
                          label: Algorithm BW (GB/s)
                          unit: GB/s
                          threshold: null
                        - key: last_time_us
                          type: MetricValue
                          label: Last Op Time (µs)
                          unit: µs
                          threshold:
                            value: 60000000
                            comparator: lte
                            statistic: null
                      acceptance_gates:
                        - multi_node_collective_rack_acceptance
                  summary: Test Catalogue Example
          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'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - test-execution:read
        - cookieAuth: []
components:
  schemas:
    TestCatalogueIncludeEnum:
      type: string
      enum:
        - all
    StageEnum:
      enum:
        - single_node
        - pairwise
        - collective
      type: string
      description: |-
        * `single_node` - Single Node
        * `pairwise` - Pairwise
        * `collective` - Collective
    TestCatalogueResponse:
      type: object
      description: Dictionary of test definitions keyed by test slug.
      additionalProperties:
        $ref: '#/components/schemas/TestCatalogueDefinition'
    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'
    TestCatalogueDefinition:
      type: object
      required:
        - slug
        - stage
        - name
        - threshold_status
        - metrics
        - acceptance_gates
      properties:
        slug:
          $ref: '#/components/schemas/TestSlugEnum'
        stage:
          $ref: '#/components/schemas/StageEnum'
        name:
          type: string
        threshold_status:
          $ref: '#/components/schemas/TestCatalogueThresholdStatusEnum'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/TestCatalogueMetricDescriptor'
        acceptance_gates:
          type: array
          items:
            type: string
            maxLength: 64
            pattern: ^[a-z0-9][a-z0-9._-]*$
    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
    TestSlugEnum:
      enum:
        - multi-node.hello-world
        - multi-node.iperf-matrix
        - multi-node.nccl-all-gather
        - multi-node.nccl-all-reduce
        - multi-node.nccl-all-reduce-multi-rack
        - multi-node.nccl-all-to-all
        - multi-node.nvloom
        - multi-node.pairwise-net-gpu.bw
        - multi-node.pairwise-net-gpu.lat
        - multi-node.pairwise-net.bw
        - multi-node.pairwise-net.lat
        - multi-node.s3-elbencho
        - multi-node.storage-elbencho
        - multi-node.training-gpt-oss-120b
        - multi-node.training-llama3-1-405b
        - multi-node.training-llama3-70b
        - multi-node.training-nemotron-24x2h
        - multi-node.training-nemotron-checkpoint
        - multi-node.training-nemotron-h
        - multi-node.training-nemotron-h-multi-rack
        - multi-node.training-qwen3-235b
        - single-node.babelstream
        - single-node.dcgmi-diag
        - single-node.gpu-fryer
        - single-node.hello-world
        - single-node.hpl-cpu
        - single-node.hpl-gpu
        - single-node.lmbench-lat-mem-rd
        - single-node.memtester
        - single-node.nccl-all-gather
        - single-node.nccl-all-reduce
        - single-node.nccl-all-reduce-loopback
        - single-node.nccl-all-to-all
        - single-node.node-health-check
        - single-node.nvme-fio
        - single-node.nvme-self-test
        - single-node.storage-elbencho
        - single-node.stream
        - single-node.stress-ng-cpu
        - single-node.training-llama3-8b
        - single-node.training-nemotronh-8b
      type: string
      description: >-
        * `multi-node.hello-world` - multi-node.hello-world

        * `multi-node.iperf-matrix` - multi-node.iperf-matrix

        * `multi-node.nccl-all-gather` - multi-node.nccl-all-gather

        * `multi-node.nccl-all-reduce` - multi-node.nccl-all-reduce

        * `multi-node.nccl-all-reduce-multi-rack` -
        multi-node.nccl-all-reduce-multi-rack

        * `multi-node.nccl-all-to-all` - multi-node.nccl-all-to-all

        * `multi-node.nvloom` - multi-node.nvloom

        * `multi-node.pairwise-net-gpu.bw` - multi-node.pairwise-net-gpu.bw

        * `multi-node.pairwise-net-gpu.lat` - multi-node.pairwise-net-gpu.lat

        * `multi-node.pairwise-net.bw` - multi-node.pairwise-net.bw

        * `multi-node.pairwise-net.lat` - multi-node.pairwise-net.lat

        * `multi-node.s3-elbencho` - multi-node.s3-elbencho

        * `multi-node.storage-elbencho` - multi-node.storage-elbencho

        * `multi-node.training-gpt-oss-120b` - multi-node.training-gpt-oss-120b

        * `multi-node.training-llama3-1-405b` -
        multi-node.training-llama3-1-405b

        * `multi-node.training-llama3-70b` - multi-node.training-llama3-70b

        * `multi-node.training-nemotron-24x2h` -
        multi-node.training-nemotron-24x2h

        * `multi-node.training-nemotron-checkpoint` -
        multi-node.training-nemotron-checkpoint

        * `multi-node.training-nemotron-h` - multi-node.training-nemotron-h

        * `multi-node.training-nemotron-h-multi-rack` -
        multi-node.training-nemotron-h-multi-rack

        * `multi-node.training-qwen3-235b` - multi-node.training-qwen3-235b

        * `single-node.babelstream` - single-node.babelstream

        * `single-node.dcgmi-diag` - single-node.dcgmi-diag

        * `single-node.gpu-fryer` - single-node.gpu-fryer

        * `single-node.hello-world` - single-node.hello-world

        * `single-node.hpl-cpu` - single-node.hpl-cpu

        * `single-node.hpl-gpu` - single-node.hpl-gpu

        * `single-node.lmbench-lat-mem-rd` - single-node.lmbench-lat-mem-rd

        * `single-node.memtester` - single-node.memtester

        * `single-node.nccl-all-gather` - single-node.nccl-all-gather

        * `single-node.nccl-all-reduce` - single-node.nccl-all-reduce

        * `single-node.nccl-all-reduce-loopback` -
        single-node.nccl-all-reduce-loopback

        * `single-node.nccl-all-to-all` - single-node.nccl-all-to-all

        * `single-node.node-health-check` - single-node.node-health-check

        * `single-node.nvme-fio` - single-node.nvme-fio

        * `single-node.nvme-self-test` - single-node.nvme-self-test

        * `single-node.storage-elbencho` - single-node.storage-elbencho

        * `single-node.stream` - single-node.stream

        * `single-node.stress-ng-cpu` - single-node.stress-ng-cpu

        * `single-node.training-llama3-8b` - single-node.training-llama3-8b

        * `single-node.training-nemotronh-8b` -
        single-node.training-nemotronh-8b
    TestCatalogueThresholdStatusEnum:
      type: string
      enum:
        - configured
        - uncalibrated
        - unavailable
    TestCatalogueMetricDescriptor:
      type: object
      required:
        - key
        - type
        - label
        - threshold
      properties:
        key:
          type: string
        type:
          $ref: '#/components/schemas/TestCatalogueMetricTypeEnum'
        label:
          type: string
        optional:
          type: boolean
        unit:
          type: string
          nullable: true
        threshold:
          allOf:
            - $ref: '#/components/schemas/CatalogueMetricThreshold'
          nullable: true
    TestCatalogueMetricTypeEnum:
      type: string
      enum:
        - MetricValue
    CatalogueMetricThreshold:
      type: object
      required:
        - value
        - comparator
        - statistic
      properties:
        value:
          type: number
        comparator:
          $ref: '#/components/schemas/ComparatorTypeEnum'
        statistic:
          allOf:
            - $ref: '#/components/schemas/StatisticEnum'
          nullable: true
    ComparatorTypeEnum:
      enum:
        - gt
        - lt
        - eq
        - gte
        - lte
      type: string
      description: |-
        * `gt` - gt
        * `lt` - lt
        * `eq` - eq
        * `gte` - gte
        * `lte` - lte
    StatisticEnum:
      type: string
      enum:
        - mean
        - min
        - max
        - median
        - stdev
  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.