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

# Rename a pipeline

> Changes the pipeline's name and nothing else: destination data is not touched, definition versions and stored CodeGen scripts (with their history) move to the new name, an incremental pull keeps its position, and every tap whose targetPipeline is the old name is re-pointed (taps the caller cannot see are re-pointed but never named). Needs the access a delete needs (own on the pipeline's catalog, or `pipeline:delete` for an API key). A rename that stopped part way is finished by sending it again. Audited as `pipeline` / `rename` on the old name with `newName` in the metadata. A caller who cannot see every pipeline gets the taken-name 409 for a new name that a pipeline hidden from it had before it was renamed (`previousNames`).



## OpenAPI

````yaml /openapi.yaml post /api/v1/pipelines/{name}/rename
openapi: 3.0.3
info:
  title: Datris API
  description: >
    REST API for the Datris AI Data Platform. Ingest, validate, transform,
    store, and retrieve data.


    For AI agent integration, use the [MCP
    Server](https://docs.datris.ai/mcp-server) instead.
  version: 1.57.1
  contact:
    name: Datris
    url: https://datris.ai
  license:
    name: Apache 2.0
servers:
  - url: http://localhost:8080
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /api/v1/pipelines/{name}/rename:
    post:
      tags:
        - Pipelines
      summary: Rename a pipeline
      description: >-
        Changes the pipeline's name and nothing else: destination data is not
        touched, definition versions and stored CodeGen scripts (with their
        history) move to the new name, an incremental pull keeps its position,
        and every tap whose targetPipeline is the old name is re-pointed (taps
        the caller cannot see are re-pointed but never named). Needs the access
        a delete needs (own on the pipeline's catalog, or `pipeline:delete` for
        an API key). A rename that stopped part way is finished by sending it
        again. Audited as `pipeline` / `rename` on the old name with `newName`
        in the metadata. A caller who cannot see every pipeline gets the
        taken-name 409 for a new name that a pipeline hidden from it had before
        it was renamed (`previousNames`).
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
          description: Current pipeline name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - newName
              properties:
                newName:
                  type: string
                  maxLength: 80
                  description: New name (trimmed)
      responses:
        '200':
          description: Renamed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRenameResult'
        '207':
          description: Renamed, but some taps could not be re-pointed (listed in `failed`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRenameResult'
        '400':
          description: >-
            newName missing, blank, unchanged or over 80 characters, or the
            pipeline syncs to Unity Catalog
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '403':
          description: >-
            The caller can see the pipeline but may not rename it (own /
            pipeline:delete required)
        '404':
          description: No such pipeline, or one the caller cannot see
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '409':
          description: >-
            The new name is taken, a job for the pipeline is queued or running,
            or a stored CodeGen script could not be copied to the new name. For
            a restricted user, an object-store pipeline also gets this 409 when
            Unity Catalog sync state kept for the new name records a catalog
            commit (500 when that state cannot be read within 5 seconds).
            Nothing is renamed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '429':
          description: >-
            Restricted users only, an object-store pipeline taking a free name:
            two destination checks of the same user are still running, so the
            Unity Catalog state read was not started and nothing was renamed:
            `Another destination check of yours is still running; nothing was
            saved. Wait a moment and try again.`
          headers:
            Retry-After:
              description: Seconds to wait before trying again (5).
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  schemas:
    PipelineRenameResult:
      type: object
      properties:
        name:
          type: string
          description: The new name
        previousName:
          type: string
        version:
          type: integer
          description: >-
            Definition version of the renamed pipeline (the rename is a new
            version)
        repointedTaps:
          type: array
          items:
            type: string
          description: Taps re-pointed to the new name that the caller can see
        failed:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              error:
                type: string
          description: Taps that could not be re-pointed (response is 207 when non-empty)
        warnings:
          type: array
          items:
            type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Optional API key for authentication (enabled via application.yaml)

````

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