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

# Create a stack from a stack profile

> Instantiates a stack profile version on the cluster with the parameter values you supply, creating a stack draft and deploying it when `deploy` is set. Requires `stacks.write`; missing or invalid parameters, unresolvable variables and draft errors answer `400`, and a deprecated version answers `409`.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/clusters/imported/{cluster_id}/stacks/from-profile
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:
  /api/v1/org/clusters/imported/{cluster_id}/stacks/from-profile:
    post:
      tags:
        - Imported Clusters
      summary: Create a stack from a stack profile
      description: >-
        Instantiates a stack profile version on the cluster with the parameter
        values you supply, creating a stack draft and deploying it when `deploy`
        is set. Requires `stacks.write`; missing or invalid parameters,
        unresolvable variables and draft errors answer `400`, and a deprecated
        version answers `409`.
      operationId: >-
        instantiate_stack_profile_endpoint_api_v1_org_clusters_imported__cluster_id__stacks_from_profile_post
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            format: uuid4
            title: Cluster Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantiateStackProfileRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstantiateStackProfileResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission or CSRF check failed
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
components:
  schemas:
    InstantiateStackProfileRequest:
      properties:
        deploy:
          default: false
          title: Deploy
          type: boolean
        new_stack_name:
          anyOf:
            - type: string
            - type: 'null'
          title: New Stack Name
        parameters:
          default: []
          items:
            $ref: '#/components/schemas/ParameterBinding'
          title: Parameters
          type: array
        profile_id:
          format: uuid4
          title: Profile Id
          type: string
        version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version
        upgrade_existing:
          type: boolean
          title: Upgrade Existing
          description: >-
            Replace the contents of the stack already deployed from this profile
            under new_stack_name (or the profile's stack name) with this
            version, in place, instead of creating a new stack draft. The
            stack-name and resource renames are skipped, the update is applied
            immediately (deploy is implied), and the profile's deployment
            tracking moves to the new version. Answers 404 when no stack runs
            under that name, and 409 when the stack was not deployed from this
            profile, when the stack now under the name is not the one the
            profile deployed (it was deleted or renamed and another took its
            name), or when the deployment record predates stack identity
            tracking and cannot prove the stack is the profile's (re-record it
            with adopt). A member the version no longer lists is removed only
            when the deployment record shows the profile put it there; any other
            removal answers 422 STACK_MEMBER_REMOVAL_UNCONFIRMED naming the
            members, unless confirmed_member_removals names them.
          default: false
        allow_chart_downgrade:
          default: false
          deprecated: true
          description: >-
            Retired. It used to admit every chart downgrade in the upgrade; it
            is still accepted as a boolean (and still only together with
            upgrade_existing), but it admits nothing. Send
            confirmed_chart_downgrades instead.
          title: Allow Chart Downgrade
          type: boolean
        confirmed_chart_downgrades:
          description: >-
            The chart downgrades the person confirmed for an in-place upgrade,
            after the same request was refused with CHART_VERSION_DOWNGRADE
            because this profile version pins add-ons to older chart versions
            than the live stack declares. Each entry admits exactly the move it
            names; any other downgrade is refused again, naming every move.
            Accepted only together with upgrade_existing (422 otherwise).
          items:
            $ref: '#/components/schemas/ConfirmedChartDowngrade'
          maxItems: 200
          title: Confirmed Chart Downgrades
          type: array
        confirmed_member_removals:
          description: >-
            The members, as kind/name (kind addon, manifest or application), the
            person confirmed an in-place upgrade may remove although this
            profile's deployment record does not show the profile put them
            there, after the same request was refused with
            STACK_MEMBER_REMOVAL_UNCONFIRMED or previewed with dry_run. Each
            entry admits exactly that removal; any other is refused again.
            Accepted only together with upgrade_existing (422 otherwise).
          items:
            type: string
          maxItems: 200
          title: Confirmed Member Removals
          type: array
        dry_run:
          default: false
          description: >-
            Preview an in-place upgrade: the target stack and the members the
            upgrade would remove are judged exactly as the upgrade would judge
            them, nothing is written, and the answer carries dry_run and
            member_removals. Accepted only together with upgrade_existing (422
            otherwise).
          title: Dry Run
          type: boolean
      required:
        - profile_id
      title: InstantiateStackProfileRequest
      type: object
    InstantiateStackProfileResult:
      properties:
        addons_count:
          title: Addons Count
          type: integer
        deployed:
          default: false
          title: Deployed
          type: boolean
        dry_run:
          description: >-
            Present, and true, only on the answer to a dry_run upgrade: nothing
            was written.
          title: Dry Run
          type: boolean
        draft_id:
          format: uuid4
          title: Draft Id
          type: string
        job_count:
          type: integer
          title: Job Count
          default: 0
        manifests_count:
          title: Manifests Count
          type: integer
        member_removals:
          description: >-
            Present only on the answer to a dry_run upgrade: every member the
            upgrade would remove, with deployed_by_profile (the deployment
            record shows the profile put it there, so it is removed without
            asking) and confirmed (named in confirmed_member_removals). A
            removal that is neither refuses the real upgrade.
          items:
            $ref: '#/components/schemas/PlannedStackMemberRemoval'
          title: Member Removals
          type: array
        operation_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          title: Operation Id
        profile_version:
          title: Profile Version
          type: integer
        stack_name:
          title: Stack Name
          type: string
        warnings:
          default: []
          items:
            type: string
          title: Warnings
          type: array
      required:
        - draft_id
        - stack_name
        - profile_version
        - addons_count
        - manifests_count
      title: InstantiateStackProfileResult
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ParameterBinding:
      properties:
        explicit:
          default: false
          description: >-
            The caller set this value on purpose. An empty value marked explicit
            binds the empty string instead of falling back to the parameter's
            default or an option's derived value; an unmarked empty value means
            the input was left untouched.
          title: Explicit
          type: boolean
        name:
          type: string
          title: Name
        value:
          title: Value
          type: string
      required:
        - name
        - value
      title: ParameterBinding
      type: object
    ConfirmedChartDowngrade:
      description: >-
        One chart downgrade a person confirmed, exactly as a
        CHART_VERSION_DOWNGRADE refusal named it (a row of
        detail.details.downgrades may be sent back verbatim; unknown members are
        ignored). It admits that one move and nothing else: the same member,
        from the same declared version, to the same proposed version. stack and
        chart_name are optional and must match the refusal when sent.
      properties:
        member_name:
          maxLength: 253
          minLength: 1
          title: Member Name
          type: string
        declared_version:
          description: >-
            The chart version the member is declared at, as the refusal named
            it.
          maxLength: 253
          minLength: 1
          title: Declared Version
          type: string
        proposed_version:
          description: >-
            The older chart version the write moves the member to, as the
            refusal named it.
          maxLength: 253
          minLength: 1
          title: Proposed Version
          type: string
        member_kind:
          enum:
            - addon
          title: Member Kind
          type: string
        chart_name:
          maxLength: 253
          title: Chart Name
          type: string
        stack:
          maxLength: 253
          title: Stack
          type: string
      required:
        - member_name
        - declared_version
        - proposed_version
      title: ConfirmedChartDowngrade
      type: object
    PlannedStackMemberRemoval:
      properties:
        confirmed:
          title: Confirmed
          type: boolean
        deployed_by_profile:
          title: Deployed By Profile
          type: boolean
        kind:
          type: string
          title: Kind
        name:
          type: string
          title: Name
      required:
        - kind
        - name
        - deployed_by_profile
        - confirmed
      title: PlannedStackMemberRemoval
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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