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

# Add a pull request to an application's merge train

> Puts a pull request at the end of the repository's merge train. Ankra tests it squashed onto the base branch and the pull requests ahead of it, exactly as the merge will land, and merges it through the host's own merge when that run passes. A pull request already in the train answers its entry with 200. Addressed by application: the merge train of the pipeline repository the application is connected to. Must be called by a person, not a service account token. Requires pipelines.operate.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/applications/{application_id}/merge-train/entries
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: 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: 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/applications/{application_id}/merge-train/entries:
    post:
      tags:
        - Pipelines
      summary: Add a pull request to an application's merge train
      description: >-
        Puts a pull request at the end of the repository's merge train. Ankra
        tests it squashed onto the base branch and the pull requests ahead of
        it, exactly as the merge will land, and merges it through the host's own
        merge when that run passes. A pull request already in the train answers
        its entry with 200. Addressed by application: the merge train of the
        pipeline repository the application is connected to. Must be called by a
        person, not a service account token. Requires pipelines.operate.
      operationId: enqueueApplicationMergeTrainToken
      parameters:
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PipelineMergeTrainEnqueue'
      responses:
        '200':
          description: The pull request was already in the train.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineMergeTrainEntry'
        '201':
          description: The pull request entered the train.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineMergeTrainEntry'
        '401':
          description: Authentication required
        '403':
          description: Missing pipelines.operate, or a service account token
        '404':
          description: The application has no pipeline repository connected
        '409':
          description: >-
            The merge train is not enabled for this repository, or the
            repository is not on GitHub
        '422':
          description: Malformed body
        '500':
          description: Internal error
      security:
        - BearerAuth: []
components:
  schemas:
    PipelineMergeTrainEnqueue:
      type: object
      required:
        - pull_request_number
      properties:
        pull_request_number:
          type: integer
          minimum: 1
        head_sha:
          type: string
          pattern: ^([a-f0-9]{40}|[a-f0-9]{64})$
          description: >-
            Pins the head the train tests and merges. Omitted pins the head the
            train reads first; a later push to the pull request takes it out of
            the train.
    PipelineMergeTrainEntry:
      type: object
      required:
        - id
        - pull_request_number
        - pull_request_head_sha
        - pull_request_title
        - base_branch
        - status
        - position
        - attempt
        - requested_by
        - requested_via
        - enqueued_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        pull_request_number:
          type: integer
        pull_request_head_sha:
          type: string
          description: >-
            The head the train tests and merges; empty until the train first
            reads the pull request.
        pull_request_title:
          type: string
        base_branch:
          type: string
        status:
          type: string
          enum:
            - queued
            - building
            - testing
            - passed
            - merging
            - merged
            - evicted
            - cancelled
        position:
          type: integer
          description: Order in the train; lower merges first.
        attempt:
          type: integer
          description: How many cars were built for this pull request.
        car_branch:
          type: string
          nullable: true
        car_base_sha:
          type: string
          pattern: ^[a-f0-9]{40}$
          nullable: true
        car_commit_sha:
          type: string
          pattern: ^[a-f0-9]{40}$
          nullable: true
        car_tree_sha:
          type: string
          pattern: ^[a-f0-9]{40}$
          nullable: true
        predecessor_entry_id:
          type: string
          format: uuid
          nullable: true
        pipeline_run_id:
          type: string
          format: uuid
          nullable: true
          description: The merge_train run testing the car.
        merge_commit_sha:
          type: string
          pattern: ^[a-f0-9]{40}$
          nullable: true
        merge_tree_matches:
          type: boolean
          nullable: true
          description: Whether the merge landed as exactly the tree the car tested.
        reason:
          type: string
          nullable: true
        reason_text:
          type: string
          nullable: true
        detail:
          type: string
          nullable: true
        requested_by:
          type: string
        requested_via:
          type: string
          enum:
            - api
            - comment
            - portal
            - tool
        enqueued_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
        finished_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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