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

# Prepare an actor-bound managed-service plan review

> Requires the applications rollout flag and live membership intersected with token scopes; reviews require applications.deploy, profiles.read and clusters.read. Preparing a review resolves the immutable package, the declared cluster policy, every explicitly bound consumer and every secret grant on the primary database, and stores an actor-bound plan with a digest and a ten-minute expiry. Confirming accepts only the stored review id and the reviewed digest, revalidates the same authority under row locks, and enqueues one cluster-scoped execution for a customer or existing-service plan; a retry returns the same receipt after current access checks. Hosted plans are refused at preparation: hosted operator-to-customer binding and cell dispatch are not wired, so nothing hosted can be reviewed or confirmed. Plans never carry credential values. The execution receipt is not proof of service readiness.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/service-admission/reviews
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: 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 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: 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: 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:
  /api/v1/org/service-admission/reviews:
    post:
      tags:
        - Services
      summary: Prepare an actor-bound managed-service plan review
      description: >-
        Requires the applications rollout flag and live membership intersected
        with token scopes; reviews require applications.deploy, profiles.read
        and clusters.read. Preparing a review resolves the immutable package,
        the declared cluster policy, every explicitly bound consumer and every
        secret grant on the primary database, and stores an actor-bound plan
        with a digest and a ten-minute expiry. Confirming accepts only the
        stored review id and the reviewed digest, revalidates the same authority
        under row locks, and enqueues one cluster-scoped execution for a
        customer or existing-service plan; a retry returns the same receipt
        after current access checks. Hosted plans are refused at preparation:
        hosted operator-to-customer binding and cell dispatch are not wired, so
        nothing hosted can be reviewed or confirmed. Plans never carry
        credential values. The execution receipt is not proof of service
        readiness.
      operationId: prepareServiceReviewToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceReviewRequest'
      responses:
        '200':
          description: >-
            The stored review, its plan and digest; confirmation adds the
            execution receipt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceReview'
        '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:
        - BearerAuth: []
components:
  schemas:
    ServiceReviewRequest:
      type: object
      additionalProperties: false
      required:
        - package_version_id
        - name
        - mode
        - region
        - data_boundary
        - cluster_id
        - consumer_ids
        - parameters
        - secret_references
      properties:
        package_version_id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
        mode:
          type: string
          enum:
            - hosted
            - customer
            - existing
        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]+)*$
        cluster_id:
          type: string
          format: uuid
          description: >-
            The service cluster for customer and existing modes. Hosted plans
            cannot be confirmed.
        consumer_ids:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: string
            format: uuid
        parameters:
          type: object
          additionalProperties:
            type: integer
            format: int64
        secret_references:
          type: object
          description: >-
            Package secret input name to credential grant id. Values are never
            accepted.
          additionalProperties:
            type: string
            format: uuid
    ServiceReview:
      type: object
      additionalProperties: false
      required:
        - id
        - package_version_id
        - plan
        - digest
        - created_at
        - execution_id
        - confirmed_at
      properties:
        id:
          type: string
          format: uuid
        package_version_id:
          type: string
          format: uuid
        plan:
          type: object
          description: >-
            The server-resolved plan (schema version 2): package digest, mode,
            location, service cluster, consumers with their policy and binding
            revisions, bounded parameters and opaque secret references. Never
            credential values.
          additionalProperties: true
        digest:
          type: string
          pattern: ^sha256:[a-f0-9]{64}$
        created_at:
          type: string
          format: date-time
        execution_id:
          type: string
          format: uuid
          nullable: true
        confirmed_at:
          type: string
          format: date-time
          nullable: true
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````