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

# Rename, reschedule or change governance

> A schedule, domain or tag change rewrites the DAG. `schedule: null`
makes the pipeline run on demand only.



## OpenAPI

````yaml patch /api/ingest/pipelines/{pipeline_id}
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/ingest/pipelines/{pipeline_id}:
    patch:
      tags:
        - Ingest pipelines
      summary: Rename, reschedule or change governance
      description: |-
        A schedule, domain or tag change rewrites the DAG. `schedule: null`
        makes the pipeline run on demand only.
      operationId: update_pipeline_api_ingest_pipelines__pipeline_id__patch
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: The pipeline's id.
            title: Pipeline Id
          description: The pipeline's id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePipelineRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineDetail'
        '400':
          description: Invalid request.
        '403':
          description: Not allowed.
        '404':
          description: No such pipeline (or file).
        '409':
          description: Conflicts with the pipeline's state.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: Airflow or the source couldn't be reached.
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    UpdatePipelineRequest:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        schedule:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule
        governance:
          anyOf:
            - $ref: '#/components/schemas/Governance'
            - type: 'null'
      type: object
      title: UpdatePipelineRequest
      description: 'Only the fields sent change; ``schedule: null`` makes it run on demand.'
    PipelineDetail:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        source_kind:
          $ref: '#/components/schemas/api__models__ingest_pipeline_models__SourceKind'
        source_summary:
          type: string
          title: Source Summary
        target_table:
          type: string
          title: Target Table
        mode:
          $ref: '#/components/schemas/WriteMode'
        schedule:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule
        schedule_label:
          type: string
          title: Schedule Label
        status:
          $ref: '#/components/schemas/PipelineStatus'
        last_run:
          anyOf:
            - $ref: '#/components/schemas/RunSummary'
            - type: 'null'
        rows_7d:
          type: integer
          title: Rows 7D
          default: 0
        owner:
          type: string
          title: Owner
        can_edit:
          type: boolean
          title: Can Edit
        merge_keys:
          items:
            type: string
          type: array
          title: Merge Keys
        governance:
          $ref: '#/components/schemas/Governance'
        job_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Job Id
        airflow_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Airflow Url
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        spec:
          additionalProperties: true
          type: object
          title: Spec
        latest_error:
          anyOf:
            - $ref: '#/components/schemas/LatestError'
            - type: 'null'
      type: object
      required:
        - id
        - name
        - source_kind
        - source_summary
        - target_table
        - mode
        - schedule_label
        - status
        - owner
        - can_edit
        - governance
        - created_at
        - updated_at
      title: PipelineDetail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Governance:
      properties:
        owner:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner
          description: Business owner, as text.
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
          description: DataHub domain urn.
        tags:
          items:
            type: string
          type: array
          maxItems: 20
          title: Tags
        classify:
          type: boolean
          title: Classify
          description: Classify the table after its first load.
          default: false
        suggest_checks:
          type: boolean
          title: Suggest Checks
          description: Suggest quality checks after its first load.
          default: false
      type: object
      title: Governance
    api__models__ingest_pipeline_models__SourceKind:
      type: string
      enum:
        - file
        - database
        - lakehouse
        - saas
      title: SourceKind
    WriteMode:
      type: string
      enum:
        - append
        - overwrite
        - merge
      title: WriteMode
    PipelineStatus:
      type: string
      enum:
        - healthy
        - failed
        - running
        - stale
        - paused
        - new
      title: PipelineStatus
    RunSummary:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        trigger:
          $ref: '#/components/schemas/RunTrigger'
        status:
          $ref: '#/components/schemas/RunStatus'
        phase:
          anyOf:
            - $ref: '#/components/schemas/RunPhase'
            - type: 'null'
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        duration_s:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration S
        rows_read:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rows Read
        rows_written:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rows Written
        checks_passed:
          anyOf:
            - type: integer
            - type: 'null'
          title: Checks Passed
        checks_total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Checks Total
        error_kind:
          anyOf:
            - $ref: '#/components/schemas/ErrorKind'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        schema_change:
          anyOf:
            - $ref: '#/components/schemas/SchemaChange'
            - type: 'null'
        governance:
          additionalProperties:
            type: string
          type: object
          title: Governance
      type: object
      required:
        - id
        - trigger
        - status
      title: RunSummary
    LatestError:
      properties:
        kind:
          $ref: '#/components/schemas/ErrorKind'
        message:
          type: string
          title: Message
        schema_change:
          anyOf:
            - $ref: '#/components/schemas/SchemaChange'
            - type: 'null'
      type: object
      required:
        - kind
        - message
      title: LatestError
    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
    RunTrigger:
      type: string
      enum:
        - schedule
        - manual
        - create
      title: RunTrigger
    RunStatus:
      type: string
      enum:
        - queued
        - running
        - succeeded
        - failed
      title: RunStatus
    RunPhase:
      type: string
      enum:
        - reading
        - writing
        - checking
        - registering
        - done
      title: RunPhase
    ErrorKind:
      type: string
      enum:
        - schema_drift
        - source_unreachable
        - cast_failed
        - dq_failed
        - permission_denied
        - other
      title: ErrorKind
    SchemaChange:
      properties:
        added:
          items:
            type: string
          type: array
          maxItems: 500
          title: Added
        changed:
          items:
            type: string
          type: array
          maxItems: 500
          title: Changed
      type: object
      title: SchemaChange
  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.