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

# Connect a repository

> Connects a repository to the organisation. By default it becomes a pipeline repository: its committed .ankra/pipeline.yaml is read from the default branch through the named credential and recorded as the definition of record, and pushes, pull requests and tags start runs. With workspaces_only true it is connected for Ankra Workspaces only: the pipeline file is not read, no definition is recorded, no run is started from any trigger and no commit status or check run is posted, which suits a repository whose pipeline already runs in another organisation. A disconnected repository with the same identity is revived. Needs pipelines.manage. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/pipelines/repositories
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/pipelines/repositories:
    post:
      tags:
        - Pipelines
      summary: Connect a repository
      description: >-
        Connects a repository to the organisation. By default it becomes a
        pipeline repository: its committed .ankra/pipeline.yaml is read from the
        default branch through the named credential and recorded as the
        definition of record, and pushes, pull requests and tags start runs.
        With workspaces_only true it is connected for Ankra Workspaces only: the
        pipeline file is not read, no definition is recorded, no run is started
        from any trigger and no commit status or check run is posted, which
        suits a repository whose pipeline already runs in another organisation.
        A disconnected repository with the same identity is revived. Needs
        pipelines.manage. A browser session twin is mounted at the same path
        without the /api/v1 prefix (cookie authentication).
      operationId: connectPipelineRepositoryToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PipelineRepositoryConnectRequest'
      responses:
        '201':
          description: >-
            The repository as stored, and what the connect did with its
            committed pipeline file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRepositoryConnected'
        '401':
          description: Authentication required
        '403':
          description: Missing the pipelines.manage permission
        '409':
          description: >-
            The organisation already connected this repository; repository_id
            names the existing row
        '422':
          description: >-
            An unknown provider, a blank or malformed owner or name, or an
            application or cluster this organisation cannot use
        '500':
          description: Internal error
      security:
        - BearerAuth: []
components:
  schemas:
    PipelineRepositoryConnectRequest:
      type: object
      description: Connect a repository to the organisation.
      required:
        - provider
        - owner
        - name
      properties:
        provider:
          enum:
            - github
            - gitlab
            - bitbucket_cloud
          type: string
        owner:
          type: string
          description: The owner, group or workspace, as one path segment.
        name:
          type: string
          description: The repository name, as one path segment.
        credential_name:
          type: string
          description: >-
            The organisation's stored Git credential the repository is read and
            cloned with.
        default_branch:
          type: string
          description: The branch the pipeline file is read from; main when empty.
        application_id:
          type: string
          description: An application of this organisation to link; empty links none.
        cluster_id:
          type: string
          description: >-
            A CI cluster override: a cluster of this organisation whose agent
            runs pipeline steps; empty stores none.
        workspaces_only:
          type: boolean
          default: false
          description: >-
            Connect the repository for Ankra Workspaces only: its pipeline file
            is not read, no definition is recorded, no run is started from any
            trigger and no commit status or check run is posted.
      title: PipelineRepositoryConnectRequest
    PipelineRepositoryConnected:
      allOf:
        - $ref: '#/components/schemas/PipelineRepository'
        - type: object
          required:
            - definition
          properties:
            definition:
              type: object
              description: What the connect did with the committed pipeline file.
              required:
                - status
                - detail
                - definition_id
                - spec_hash
                - violations
                - read_error
              properties:
                status:
                  type: string
                  enum:
                    - recorded
                    - already_recorded
                    - absent
                    - unreadable
                    - invalid
                    - unknown
                    - workspaces_only
                  description: >-
                    workspaces_only: the repository was connected for Workspaces
                    only, so the file was not read.
                detail:
                  type: string
                  description: The sentence behind status.
                definition_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                spec_hash:
                  anyOf:
                    - type: string
                    - type: 'null'
                violations:
                  type: array
                  items:
                    type: string
                read_error:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: Why the committed file could not be read, when it could not.
      description: >-
        A repository just connected, and what the connect did with its committed
        pipeline file.
      title: PipelineRepositoryConnected
    PipelineRepository:
      type: object
      description: A repository connected to Ankra Pipelines.
      required:
        - id
        - organisation_id
        - provider
        - owner
        - name
        - credential_name
        - default_branch
        - application_id
        - cluster_id
        - created_at
        - updated_at
        - last_trigger
      properties:
        id:
          type: string
          format: uuid
        organisation_id:
          type: string
          format: uuid
        provider:
          enum:
            - github
            - gitlab
            - bitbucket_cloud
          type: string
        owner:
          type: string
        name:
          type: string
        credential_name:
          type: string
        default_branch:
          type: string
        application_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The linked application; null when none.
        cluster_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The repository's CI cluster override; null when its runs follow the
            organisation's CI settings.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        last_trigger:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: >-
            What the trigger last decided for this repository; null when it has
            never decided anything.
        merge_train_enabled:
          type: boolean
          description: >-
            Whether the repository's merge train is on (GET .../merge-train
            answers the same value with the queue).
        merge_train_max_cars:
          type: integer
          minimum: 1
          maximum: 8
          description: How many pull requests the repository's merge train tests at once.
        workspaces_only:
          type: boolean
          description: >-
            The repository is connected for Ankra Workspaces only: no push, pull
            request, tag, schedule, merge train or manual dispatch starts a
            pipeline run for it, no commit status or check run is posted for it,
            and no pipeline definition is recorded for it. Workspaces (up, runs,
            the clone credential, workspace profiles) work as for any connected
            repository.
      title: PipelineRepository
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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