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

# Open an approved portability pull request (browser session)

> Claims one approved portability pull request action under a plan-level Launch Plan approval, once, and queues the operation that opens it on the application's own repository: the adapter pull request of a dependency the approver moved to needs-portability-pr, or the next.config pull request of a Vercel source. Refused unless the approval is the caller's own, unexpired and unrevoked, the application's live Launch Plan still hashes as approved, the action is an approved portability pull request not yet claimed, and the caller still holds applications.write. The operation renders the change from the newest App Contract at the plan's commit and opens it through the setup write guard; when Ankra cannot make the change with confidence it fails with the reason a person has to, verbatim. Ankra records the pull request for the PR shepherd and never merges it. Audited, refusals included.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /org/applications/{application_id}/launch-plan/approvals/{approval_id}/portability-pull-requests
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts, and no operation is
    served without one. This document is published deliberately: it describes
    the contract only and carries no organisation data or credentials. Report
    security issues to security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - 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: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - 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: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - 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: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - 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:
  /org/applications/{application_id}/launch-plan/approvals/{approval_id}/portability-pull-requests:
    post:
      tags:
        - Applications
      summary: Open an approved portability pull request (browser session)
      description: >-
        Claims one approved portability pull request action under a plan-level
        Launch Plan approval, once, and queues the operation that opens it on
        the application's own repository: the adapter pull request of a
        dependency the approver moved to needs-portability-pr, or the
        next.config pull request of a Vercel source. Refused unless the approval
        is the caller's own, unexpired and unrevoked, the application's live
        Launch Plan still hashes as approved, the action is an approved
        portability pull request not yet claimed, and the caller still holds
        applications.write. The operation renders the change from the newest App
        Contract at the plan's commit and opens it through the setup write
        guard; when Ankra cannot make the change with confidence it fails with
        the reason a person has to, verbatim. Ankra records the pull request for
        the PR shepherd and never merges it. Audited, refusals included.
      operationId: open_application_launch_plan_portability_pull_request
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
        - in: path
          name: approval_id
          required: true
          schema:
            type: string
            title: Approval Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchPlanActionClaimRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchPlanPortabilityPullRequest'
          description: The claimed action and the operation that opens the pull request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            The caller lacks the route's permission or the action's permission
            (permission_denied, naming it), is not the approver, or names an
            action outside the approved list
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Not found ("Application not found", "Launch plan approval not
            found")
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            The Launch Plan changed since it was approved, the application has
            no plan, or the approval expired or was revoked, its cluster left
            the organisation, or the action was already claimed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: >-
            Validation Error, or the approved action is not a portability pull
            request
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    LaunchPlanActionClaimRequest:
      type: object
      title: LaunchPlanActionClaimRequest
      description: The approved action the caller is about to perform.
      required:
        - action_key
      properties:
        action_key:
          type: string
          title: Action Key
    LaunchPlanPortabilityPullRequest:
      type: object
      title: LaunchPlanPortabilityPullRequest
      description: >-
        An approved portability pull request action, claimed once, and the
        operation that opens the pull request. The operation's result names the
        pull request, or the reason a person has to make the change.
      required:
        - approval_id
        - action
        - claimed_at
        - operation_id
      properties:
        approval_id:
          type: string
          title: Approval Id
        action:
          $ref: '#/components/schemas/LaunchPlanApprovalAction'
        claimed_at:
          type: string
          format: date-time
          title: Claimed At
        operation_id:
          type: string
          title: Operation Id
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    LaunchPlanApprovalAction:
      type: object
      title: LaunchPlanApprovalAction
      description: >-
        One action of an approved list (schema ankra.launch-plan-approval/v1,
        enginekit/launchplan): its stable key (kind:subject), the AI tool that
        performs it (empty when no tool can yet), the permission its approver
        had to hold and a claimant must still hold, and the tool parameters a
        matching call must carry.
      required:
        - key
        - kind
        - subject
        - title
        - tool
        - permission
        - is_cluster_scoped
        - bound_parameters
        - free_parameters
        - is_value_included
      properties:
        key:
          type: string
          title: Key
        kind:
          type: string
          title: Kind
          enum:
            - stack
            - secret
            - apply-secrets
            - merge-pull-request
            - deploy
            - domain
            - data-migration
            - portability-pull-request
        subject:
          type: string
          title: Subject
        title:
          type: string
          title: Title
        tool:
          type: string
          title: Tool
        permission:
          type: string
          title: Permission
        is_cluster_scoped:
          type: boolean
          title: Is Cluster Scoped
        bound_parameters:
          type: object
          title: Bound Parameters
          additionalProperties:
            type: string
        free_parameters:
          type: array
          items:
            type: string
          title: Free Parameters
        is_value_included:
          type: boolean
          title: Is Value Included
          description: >-
            A secret action whose value the approver consented to have written;
            without it only the name is covered.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````

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