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

# Bind an explicit application namespace

> Requires the applications rollout flag and live membership intersected with token scopes. Cluster policy reads require clusters.read and writes clusters.write. Consumer reads require applications.read and clusters.read; binding requires applications.deploy, clusters.operate and clusters.read. Locations are organisation declarations, not independently verified. No service deployment is executed. Updates require the current revision; zero creates only. Browser mutations require CSRF.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /org/service-admission/consumers
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: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - 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: 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 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: 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: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - 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: 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.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /org/service-admission/consumers:
    post:
      tags:
        - Services
      summary: Bind an explicit application namespace
      description: >-
        Requires the applications rollout flag and live membership intersected
        with token scopes. Cluster policy reads require clusters.read and writes
        clusters.write. Consumer reads require applications.read and
        clusters.read; binding requires applications.deploy, clusters.operate
        and clusters.read. Locations are organisation declarations, not
        independently verified. No service deployment is executed. Updates
        require the current revision; zero creates only. Browser mutations
        require CSRF.
      operationId: bindServiceConsumerSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceConsumerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceConsumer'
        '307':
          description: Redirect to login
        '401':
          description: Authentication required
        '403':
          description: Insufficient permission or missing browser CSRF
        '404':
          description: Not accessible, absent, or rollout disabled
        '409':
          description: Stale revision, missing policy or unavailable deployment binding
        '422':
          description: Invalid or ambiguous request
        '500':
          description: Internal error
        '503':
          description: Rollout availability could not be verified
      security:
        - SessionCookie: []
components:
  schemas:
    ServiceConsumerRequest:
      type: object
      additionalProperties: false
      required:
        - application_id
        - cluster_id
        - namespace
        - allow_planned
        - local_only
        - expected_revision
      properties:
        application_id:
          type: string
          format: uuid
        cluster_id:
          type: string
          format: uuid
        namespace:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
        allow_planned:
          type: boolean
        local_only:
          type: boolean
        expected_revision:
          type: integer
          format: int64
          minimum: 0
    ServiceConsumer:
      type: object
      additionalProperties: false
      required:
        - id
        - application_id
        - organisation_id
        - cluster_id
        - namespace
        - region
        - data_boundary
        - policy_revision
        - binding_revision
        - binding_kind
        - installation_id
        - local_only
      properties:
        id:
          type: string
          format: uuid
        application_id:
          type: string
          format: uuid
        organisation_id:
          type: string
          format: uuid
        cluster_id:
          type: string
          format: uuid
        namespace:
          type: string
        region:
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
        data_boundary:
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
        policy_revision:
          type: integer
          format: int64
          minimum: 1
        binding_revision:
          type: integer
          format: int64
          minimum: 1
        binding_kind:
          type: string
          enum:
            - planned
            - installation
        installation_id:
          type: string
          format: uuid
          description: >-
            Nil UUID for a planned binding. An installation identity does not
            imply readiness.
        local_only:
          type: boolean
  securitySchemes:
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````