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

# List maintenance runs



## OpenAPI

````yaml get /api/maintenance/runs
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/maintenance/runs:
    get:
      tags:
        - Iceberg maintenance
      summary: List maintenance runs
      operationId: list_runs_api_maintenance_runs_get
      parameters:
        - name: trigger
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 32
              - type: 'null'
            description: schedule, manual or agent.
            title: Trigger
          description: schedule, manual or agent.
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 64
              - type: 'null'
            description: planning, running, succeeded, partial or failed.
            title: Status
          description: planning, running, succeeded, partial or failed.
        - name: catalog
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            description: Only runs that planned this catalog.
            title: Catalog
          description: Only runs that planned this catalog.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            title: Offset
            default: 0
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    RunPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/RunOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        offset:
          type: integer
          title: Offset
        limit:
          type: integer
          title: Limit
      type: object
      required:
        - items
        - total
        - offset
        - limit
      title: RunPage
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RunOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        dag_run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Dag Run Id
        trigger:
          type: string
          title: Trigger
        requested_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Requested By
        status:
          type: string
          title: Status
        started_at:
          type: string
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        tables_scanned:
          type: integer
          title: Tables Scanned
          default: 0
        tables_selected:
          type: integer
          title: Tables Selected
          default: 0
        batches:
          type: integer
          title: Batches
          default: 0
        request:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Request
        summary:
          additionalProperties: true
          type: object
          title: Summary
      type: object
      required:
        - id
        - trigger
        - status
        - started_at
      title: RunOut
      description: >-
        A maintenance run. ``summary`` has Task 21's shape: ``catalogs{name:
        {...}}``,

        ``top_failures``, ``worst_health``.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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