> ## 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.

# Finish a run: summary, alerts, notifications



## OpenAPI

````yaml post /api/maintenance/internal/runs/{run_id}/finish
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/internal/runs/{run_id}/finish:
    post:
      tags:
        - Maintenance (internal)
      summary: 'Finish a run: summary, alerts, notifications'
      operationId: finish_api_maintenance_internal_runs__run_id__finish_post
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
        '501':
          description: Not Implemented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    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``.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
  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.