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

# Get pipeline plan

> Any Pipeline Plan this deployment recorded, active or not. Plans are immutable, so an earlier plan stays readable after an activation. Requires plugins:admin.



## OpenAPI

````yaml /openapi.yaml get /v0/admin/plugins/plans/{plan_id}
openapi: 3.1.0
info:
  title: Quivr HTTP API
  version: 0.0.0-draft
  description: >-
    Every endpoint of the Quivr v0 HTTP API. Send an API key as a bearer token;
    the key decides the Organization, the actions and the Corpora a request may
    reach.
servers: []
security:
  - ApiKey: []
paths:
  /v0/admin/plugins/plans/{plan_id}:
    get:
      tags:
        - Admin
      summary: Get pipeline plan
      description: >-
        Any Pipeline Plan this deployment recorded, active or not. Plans are
        immutable, so an earlier plan stays readable after an activation.
        Requires plugins:admin.
      operationId: getPipelinePlan
      parameters:
        - name: plan_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelinePlan'
        default:
          description: >-
            Structured error; 401 unauthenticated, 403 without plugins:admin,
            404 unknown plan, 503 storage unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PipelinePlan:
      type: object
      additionalProperties: false
      properties:
        plan_id:
          type: string
          minLength: 1
        created_at:
          type: string
          format: date-time
        activated_at:
          type: string
          format: date-time
        source:
          type: string
          enum:
            - configuration
            - activation
            - rollback
          description: >-
            What recorded the plan, and so why the plan changed. configuration
            is the startup configuration, which applies the roles its pins
            changed since it last applied, even over an earlier activation of
            the same role. activation is an operator activation. rollback is an
            operator rollback to an earlier plan's roles.
        previous_plan_id:
          type: string
          minLength: 1
          description: >-
            The plan this one replaced; absent for the first plan of the
            deployment.
        roles:
          type: array
          description: One entry per role, sorted by role.
          items:
            $ref: '#/components/schemas/PipelinePlanRole'
      required:
        - plan_id
        - created_at
        - activated_at
        - source
        - roles
    Error:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        retryable:
          type: boolean
        field:
          type: string
          minLength: 1
          description: >-
            JSON Pointer (RFC 6901) to the request member that caused a 422,
            when known (for example /config/url or /credential/secret/token on
            connector commands).
        resync_url:
          type: string
          format: uri-reference
      required:
        - code
        - message
        - retryable
    PipelinePlanRole:
      type: object
      additionalProperties: false
      properties:
        role:
          type: string
          minLength: 1
        registration_id:
          type: string
          minLength: 1
        plugin_id:
          type: string
          minLength: 1
        version:
          type: string
          minLength: 1
      required:
        - role
        - registration_id
        - plugin_id
        - version
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        API key, not necessarily a JWT. Server derives Organization, permitted
        actions and Corpus scope; every resource access is authorized.

````