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

# Start or resume an application deploy run

> Hand the deploy wizard's whole ordered multi-stack deploy to the server. The run is persisted before anything is created - roles, drafts, and the stack name derived for each - and the maintenance supervisor creates each stack in turn, waiting for every stack that has another behind it to report up. Closing the browser tab no longer strands the remaining stacks. A request made while a run for the same application and cluster is already in flight joins that run and answers with resumed=true rather than starting a rival queue. Browser session authentication with the X-Ankra-CSRF double-submit header only (no bearer twin).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /org/applications/{application_id}/deploy-runs
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - 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.
paths:
  /org/applications/{application_id}/deploy-runs:
    post:
      tags:
        - Applications
      summary: Start or resume an application deploy run
      description: >-
        Hand the deploy wizard's whole ordered multi-stack deploy to the server.
        The run is persisted before anything is created - roles, drafts, and the
        stack name derived for each - and the maintenance supervisor creates
        each stack in turn, waiting for every stack that has another behind it
        to report up. Closing the browser tab no longer strands the remaining
        stacks. A request made while a run for the same application and cluster
        is already in flight joins that run and answers with resumed=true rather
        than starting a rival queue. Browser session authentication with the
        X-Ankra-CSRF double-submit header only (no bearer twin).
      operationId: start_application_deploy_run
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDeployRunRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployRunResponse'
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Not found ("Application not found", "Target cluster not found in
            this organisation.", or "Deploy run not found")
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    StartDeployRunRequest:
      properties:
        cluster_id:
          type: string
          title: Cluster Id
        roles:
          items:
            $ref: '#/components/schemas/DeployRunRoleRequest'
          title: Roles
          type: array
          description: >-
            The queue in deploy order: platform stacks first, the application
            stack last.
        namespace:
          title: Namespace
          type: string
          description: >-
            Where the application's workload lands on this cluster. The
            application role's stack deploys the manifests committed under
            .ankra/manifests, rendered into this namespace; a run that omits it
            promotes its designed stacks unchanged.
        deploy_mode:
          title: Deploy Mode
          type: string
          description: >-
            Sizing the deploy chose ('quick' or 'high_availability'). Omitted is
            default sizing.
        parameters:
          title: Parameters
          type: object
          additionalProperties:
            type: string
          description: >-
            Answers to the application's option contract that no repository can
            hold - the ingress host and class this cluster publishes it on.
            Options the contract declares a default for, and the image tag of
            the application's own most recent successful publish, are resolved
            at render time and need not be sent.
        analysis_id:
          title: Analysis Id
          type: string
          description: >-
            The deploy analysis this run was designed from, when there was one.
            The server verifies it against the analysis it actually ran for this
            application before recording the journey's analyse phase; an id it
            cannot verify records nothing.
      required:
        - cluster_id
        - roles
      title: StartDeployRunRequest
      type: object
    DeployRunResponse:
      properties:
        id:
          title: Id
          type: string
        cluster_id:
          type: string
          title: Cluster Id
        status:
          title: Status
          type: string
          description: pending, running, succeeded, or failed.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        resumed:
          title: Resumed
          type: boolean
          description: >-
            True when the request joined a run that was already in flight
            instead of starting a new one.
        divergence:
          anyOf:
            - type: string
            - type: 'null'
          title: Divergence
          description: >-
            How a resumed run differs from the queue the request carried (a role
            not in the run, a role deploying a different stack name or draft, or
            a differing role count). Null when the request asked for what is
            already in flight, and always null on a run this request started.
        roles:
          items:
            $ref: '#/components/schemas/DeployRunRole'
          title: Roles
          type: array
        phases:
          items:
            $ref: '#/components/schemas/DeployRunPhase'
          title: Phases
          type: array
          description: >-
            The run's journey timeline (analyse, build, stacks, dns,
            certificate, serving) in narration order, carrying only the phases
            an observation site stamped. A journey phase absent from the list
            was never observed.
      required:
        - id
        - cluster_id
        - status
        - message
        - resumed
        - divergence
        - roles
        - phases
      title: DeployRunResponse
      type: object
    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
    DeployRunRoleRequest:
      properties:
        role:
          type: string
          title: Role
        draft_id:
          title: Draft Id
          type: string
        stack_name:
          title: Stack Name
          type: string
      required:
        - role
        - draft_id
        - stack_name
      title: DeployRunRoleRequest
      type: object
    DeployRunRole:
      properties:
        role:
          type: string
          title: Role
        position:
          title: Position
          type: integer
        draft_id:
          title: Draft Id
          type: string
        stack_name:
          title: Stack Name
          type: string
        created_stack_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Created Stack Name
          description: The name the cluster used, present once the stack has been created.
        operation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Operation Id
        status:
          title: Status
          type: string
          description: pending, creating, waiting, stalled, deployed, or failed.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: Why the role stopped, when it did.
      required:
        - role
        - position
        - draft_id
        - stack_name
        - created_stack_name
        - operation_id
        - status
        - message
      title: DeployRunRole
      type: object
    DeployRunPhase:
      properties:
        phase:
          title: Phase
          type: string
          description: analyse, build, stacks, dns, certificate, or serving.
        status:
          title: Status
          type: string
          description: pending, running, succeeded, failed, or skipped.
        detail:
          anyOf:
            - type: object
            - type: 'null'
          title: Detail
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
      required:
        - phase
        - status
        - detail
        - started_at
        - finished_at
      title: DeployRunPhase
      type: object
    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

````