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

# Propose a service connection from a demo

> Observes one running demo of a stack profile on the organisation's staging cluster and proposes the connection blocks a service package built from the profile could declare: one per Service port speaking PostgreSQL, Redis, NATS, OpenSearch, S3, VictoriaLogs or VictoriaMetrics, with each field mapped to a key of the Secret that holds the most of its credentials. Only Service ports and Secret key names are read, never Secret values, and nothing is written or tried. `observable` false means the demo's namespace could not be observed yet (the demo is not ready, or the staging cluster could not list its Services and Secrets) and `reason` says why; it is never an empty answer. Publishing the package lets the readiness canary verify the connection.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/stack-profiles/{profile_id}/demos/{workspace_id}/connection-proposal
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
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: 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: 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/stack-profiles/{profile_id}/demos/{workspace_id}/connection-proposal:
    get:
      tags:
        - Stack Profiles
      summary: Propose a service connection from a demo
      description: >-
        Observes one running demo of a stack profile on the organisation's
        staging cluster and proposes the connection blocks a service package
        built from the profile could declare: one per Service port speaking
        PostgreSQL, Redis, NATS, OpenSearch, S3, VictoriaLogs or
        VictoriaMetrics, with each field mapped to a key of the Secret that
        holds the most of its credentials. Only Service ports and Secret key
        names are read, never Secret values, and nothing is written or tried.
        `observable` false means the demo's namespace could not be observed yet
        (the demo is not ready, or the staging cluster could not list its
        Services and Secrets) and `reason` says why; it is never an empty
        answer. Publishing the package lets the readiness canary verify the
        connection.
      operationId: propose_stack_profile_demo_connection_api_v1
      parameters:
        - name: profile_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: workspace_id
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StackProfileDemoConnectionProposal'
          description: The proposals, or why the demo could not be observed
        '401':
          description: Unauthorized
        '404':
          description: Profile or demo not found
        '500':
          description: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    StackProfileDemoConnectionProposal:
      type: object
      properties:
        demo_status:
          type: string
          description: The demo's status when it was asked.
        observable:
          type: boolean
          description: >-
            Whether the demo's namespace was observed. False means it could not
            be observed yet, never that it holds nothing; `reason` says why.
        reason:
          type: string
          description: >-
            Why the namespace was not observed, or why an observed one proposes
            nothing; empty otherwise.
        observed_services:
          type: integer
          description: How many Services the observation listed.
        observed_secrets:
          type: integer
          description: How many Secrets the observation listed, by name and key names only.
        proposals:
          type: array
          items:
            $ref: '#/components/schemas/ServicePackageConnectionProposal'
          description: >-
            At most 10, most likely first: complete before incomplete, then by
            confidence.
        note:
          type: string
          description: That the proposals are untried and how publishing verifies them.
      required:
        - demo_status
        - observable
        - reason
        - observed_services
        - observed_secrets
        - proposals
        - note
      title: StackProfileDemoConnectionProposal
    ServicePackageConnectionProposal:
      type: object
      properties:
        connection:
          $ref: '#/components/schemas/ServicePackageConnection'
        complete:
          type: boolean
          description: >-
            True only when every field maps and the connection passes the
            validation publishing applies.
        confidence:
          type: string
          enum:
            - high
            - medium
            - low
          description: >-
            `high`: the protocol's own port and every field maps; `medium`:
            every field maps but the port only suggests the protocol or the
            Service is headless; `low`: a field is unresolved.
        unresolved:
          type: array
          items:
            type: string
          description: >-
            The protocol's connection fields nothing maps, left out of
            `connection.fields` for you to fill in.
        reasons:
          type: array
          items:
            type: string
          description: Why each part was proposed, in plain sentences.
      required:
        - connection
        - complete
        - confidence
        - unresolved
        - reasons
      title: ServicePackageConnectionProposal
    ServicePackageConnection:
      type: object
      properties:
        protocol:
          type: string
          description: >-
            The protocol consumers speak: postgresql, redis, nats, opensearch,
            s3, victorialogs or victoriametrics.
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/ServicePackageConnectionEndpoint'
          description: >-
            The Services the engine listens on; the first is the one consumers
            are pointed at.
        secret_name:
          type: string
          description: >-
            The Secret the engine writes its credentials into; empty when none
            was found.
        secret_keys:
          type: array
          items:
            type: string
          description: The keys of that Secret the connection copies.
        fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ServicePackageConnectionSource'
          description: Where each connection field comes from, keyed by field name.
      required:
        - protocol
        - endpoints
        - secret_name
        - secret_keys
        - fields
      title: ServicePackageConnection
    ServicePackageConnectionEndpoint:
      type: object
      properties:
        name:
          type: string
        scheme:
          type: string
          description: >-
            The URL scheme, empty for a protocol whose clients take a bare
            host:port.
        service:
          type: string
        port:
          type: integer
      required:
        - name
        - scheme
        - service
        - port
      title: ServicePackageConnectionEndpoint
    ServicePackageConnectionSource:
      type: object
      properties:
        kind:
          type: string
          enum:
            - secret_key
            - literal
            - primary_host
            - primary_address
        value:
          type: string
          description: >-
            The Secret key, or the literal; empty for the primary endpoint's
            host or address.
      required:
        - kind
        - value
      title: ServicePackageConnectionSource
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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