> ## 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. # Get a stack profile > Returns a profile visible to the caller with its version list, the latest and current version details, and how many deployments are outdated or on deprecated versions. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/stack-profiles/{profile_id} 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 `. 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: Playground description: >- The organisation's playground cluster: order one, read its provisioning status, list the orderable sizes, resize it and destroy it. - 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: Cluster Meshes description: >- Cilium ClusterMeshes that join an organisation's clusters into one network: create a mesh, check whether clusters can join, prepare a running cluster, and add or remove members. - 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: Proxmox Clusters description: >- Self-managed Kubernetes clusters Ankra builds on Proxmox VE VMs: the node, storage, bridge, template and size catalogs, create and teardown, start and stop, node groups, nodes, standalone VMs, upgrades and the bastion. - name: HPE Morpheus Clusters description: >- Self-managed Kubernetes clusters Ankra builds on HPE Morpheus VMs: the group, cloud, plan, layout and network catalogs, create and teardown, start and stop, node groups, nodes, standalone VMs, upgrades and the bastion. - 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: Projects description: >- Projects group an organisation's clusters, applications, credentials and other resources beneath it: list, create, rename and delete them, switch the current project, see who reaches one, and move resources between them. - name: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address, and the AI provider keys your own work runs on. - 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:} 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/stack-profiles/{profile_id}: get: tags: - Stack Profiles summary: Get a stack profile description: >- Returns a profile visible to the caller with its version list, the latest and current version details, and how many deployments are outdated or on deprecated versions. operationId: get_stack_profile_api_v1 parameters: - in: path name: profile_id required: true schema: type: string format: uuid responses: '200': description: The profile content: application/json: schema: $ref: '#/components/schemas/StackProfileDetail' '401': description: Unauthorized '404': description: Stack profile not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - BearerAuth: [] components: schemas: StackProfileDetail: type: object properties: profile: $ref: '#/components/schemas/StackProfileSummary' versions: type: array items: $ref: '#/components/schemas/StackProfileVersionSummary' latest_version_detail: anyOf: - $ref: '#/components/schemas/StackProfileVersionDetail' - type: 'null' current_version_detail: anyOf: - $ref: '#/components/schemas/StackProfileVersionDetail' - type: 'null' update_status: $ref: '#/components/schemas/StackProfileUpdateStatus' required: - profile - versions - latest_version_detail - current_version_detail - update_status HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object StackProfileSummary: properties: id: type: string format: uuid organisation_id: type: string format: uuid name: type: string description: anyOf: - type: string - type: 'null' logo_url: anyOf: - type: string - type: 'null' has_uploaded_logo: type: boolean uploaded_logo_updated_at: anyOf: - type: string format: date-time - type: 'null' category: type: string tags: type: array items: type: string visibility: enum: - organisation - public type: string latest_version: type: integer current_version: type: integer source_cluster_id: anyOf: - type: string format: uuid - type: 'null' created_by_user_id: anyOf: - type: string - type: 'null' created_at: type: string format: date-time updated_at: type: string format: date-time publisher_name: anyOf: - type: string - type: 'null' publisher_slug: anyOf: - type: string - type: 'null' publisher_verified: type: boolean publisher_is_ankra: type: boolean publisher_has_logo: type: boolean publisher_logo_updated_at: anyOf: - type: string format: date-time - type: 'null' shared_organisation_count: type: integer shared_with_you: type: boolean is_owner: type: boolean required: - id - organisation_id - name - description - logo_url - has_uploaded_logo - uploaded_logo_updated_at - category - tags - visibility - latest_version - current_version - source_cluster_id - created_by_user_id - created_at - updated_at - publisher_name - publisher_slug - publisher_verified - publisher_is_ankra - publisher_has_logo - publisher_logo_updated_at - shared_organisation_count - shared_with_you - is_owner title: StackProfileSummary type: object StackProfileVersionSummary: type: object properties: id: type: string format: uuid version: type: integer channel: type: string changelog: nullable: true type: string created_by_user_id: nullable: true type: string created_at: type: string format: date-time deprecation: anyOf: - $ref: '#/components/schemas/StackProfileVersionDeprecation' - type: 'null' description: The withdrawal notice; null while the version is deployable. required: - id - version - channel - changelog - created_by_user_id - created_at - deprecation title: StackProfileVersionSummary StackProfileVersionDetail: type: object properties: id: type: string format: uuid version: type: integer channel: type: string spec: type: object additionalProperties: true description: >- The profile's stack specification: stacks with their add-ons, manifests and variables. parameters: type: array items: $ref: '#/components/schemas/StackProfileParameter' redacted_secret_paths: type: object additionalProperties: type: array items: type: string description: Secret paths redacted from the stored spec, keyed by resource. changelog: type: - string - 'null' created_by_user_id: type: - string - 'null' created_at: type: string format: date-time deprecation: anyOf: - $ref: '#/components/schemas/StackProfileVersionDeprecation' - type: 'null' description: The withdrawal notice; null while the version is deployable. warnings: type: array items: type: string description: >- Only on a newly saved version: redaction and unsubstituted-variable notices. required: - id - version - channel - spec - parameters - redacted_secret_paths - changelog - created_by_user_id - created_at - deprecation description: >- One published version of a stack profile with its full spec and parameters. StackProfileUpdateStatus: type: object properties: outdated_instantiation_count: type: integer has_update_available: type: boolean deprecated_instantiation_count: type: integer description: Live deployments still running a deprecated version. required: - outdated_instantiation_count - has_update_available - deprecated_instantiation_count 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 StackProfileVersionDeprecation: type: object properties: reason: type: string enum: - incompatibility - critical_bug - cve note: nullable: true type: string references: type: array items: type: string deprecated_at: type: string format: date-time deprecated_by_user_id: nullable: true type: string required: - reason - note - references - deprecated_at - deprecated_by_user_id title: StackProfileVersionDeprecation StackProfileParameter: type: object properties: name: type: string title: type: - string - 'null' description: type: - string - 'null' type: type: string enum: - string - number - boolean - enum - secret default: string required: type: boolean default: false default: type: - string - 'null' enum_values: type: array items: type: string pattern: type: - string - 'null' group: type: - string - 'null' resource_kind: type: - string - 'null' resource_name: type: - string - 'null' path: type: - string - 'null' description: Dotted path of the value inside the resource the parameter fills. options: type: array items: $ref: '#/components/schemas/StackProfileParameterOption' description: Authored option sets; absent unless the author declared choices. required: - name description: An input a stack profile asks for when it is instantiated. StackProfileParameterOption: type: object properties: value: type: string title: type: string description: type: string sets: type: object additionalProperties: type: string description: Other parameters this choice sets, by parameter name. required: - value description: >- One choice of a parameter that also moves other parameters together. Omitted fields are absent. securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.