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

# List cluster access policy proposals

> The organisation's cluster access policy proposals, newest first (at most 20; is_capped says when more matched). status filters by the status a proposal reads as: a pending proposal past its expiry reads as expired. Readable with `kube_access.manage`, `kube_access.policy` or `kube_access.elevate`, like the policy itself.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/cluster-access-policy/proposals
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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/cluster-access-policy/proposals:
    get:
      tags:
        - Cluster Access
      summary: List cluster access policy proposals
      description: >-
        The organisation's cluster access policy proposals, newest first (at
        most 20; is_capped says when more matched). status filters by the status
        a proposal reads as: a pending proposal past its expiry reads as
        expired. Readable with `kube_access.manage`, `kube_access.policy` or
        `kube_access.elevate`, like the policy itself.
      operationId: >-
        list_cluster_access_policy_proposals_api_v1_org_cluster_access_policy_proposals_get
      parameters:
        - in: query
          name: status
          required: false
          schema:
            type: string
            enum:
              - pending
              - applied
              - dismissed
              - expired
              - superseded
            title: Status
        - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterAccessPolicyProposalList'
          description: Successful Response
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: '"permission_denied" (requires kube_access.manage)'
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ClusterAccessPolicyProposalList:
      type: object
      title: ClusterAccessPolicyProposalList
      required:
        - proposals
        - is_capped
      properties:
        proposals:
          type: array
          items:
            $ref: '#/components/schemas/ClusterAccessPolicyProposal'
          title: Proposals
        is_capped:
          type: boolean
          title: Is Capped
    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
    ClusterAccessPolicyProposal:
      type: object
      title: ClusterAccessPolicyProposal
      required:
        - id
        - status
        - proposed
        - base
        - current
        - base_matches_current
        - reason
        - proposed_by
        - created_at
        - expires_at
        - decided_by_user_id
        - decided_at
        - decision_note
        - apply_url
      properties:
        id:
          type: string
          format: uuid
          title: Id
        status:
          type: string
          enum:
            - pending
            - applied
            - dismissed
            - expired
            - superseded
          title: Status
          description: A pending proposal past expires_at reads as expired.
        proposed:
          $ref: '#/components/schemas/ProposedClusterAccessPolicy'
        base:
          $ref: '#/components/schemas/ClusterAccessPolicy'
        current:
          $ref: '#/components/schemas/ClusterAccessPolicy'
        base_matches_current:
          type: boolean
          title: Base Matches Current
          description: >-
            false means the policy changed since the proposal was made, and
            applying it answers 409 policy_changed.
        reason:
          title: Reason
          type: string
        proposed_by:
          $ref: '#/components/schemas/ClusterAccessPolicyProposalPrincipal'
        created_at:
          type: string
          format: date-time
          title: Created At
        expires_at:
          type: string
          format: date-time
          title: Expires At
        decided_by_user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Decided By User Id
        decided_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Decided At
        decision_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Decision Note
        apply_url:
          type: string
          title: Apply Url
          description: >-
            The Ankra web app page (Organisation > Roles, with ?org= and
            ?proposal=) an owner or admin applies the proposal from, signed in.
    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
    ProposedClusterAccessPolicy:
      type: object
      title: ProposedClusterAccessPolicy
      required:
        - creator_grant_role
        - max_grant_role
        - elevated_max_ttl_seconds
        - require_reason_from_role
      properties:
        creator_grant_role:
          type: string
          enum:
            - none
            - view
            - edit
            - admin
            - cluster-admin
          title: Creator Grant Role
        max_grant_role:
          type: string
          enum:
            - view
            - edit
            - admin
            - cluster-admin
          title: Max Grant Role
        elevated_max_ttl_seconds:
          anyOf:
            - type: integer
              minimum: 60
              maximum: 31536000
            - type: 'null'
          title: Elevated Max Ttl Seconds
        require_reason_from_role:
          anyOf:
            - type: string
              enum:
                - view
                - edit
                - admin
                - cluster-admin
            - type: 'null'
          title: Require Reason From Role
    ClusterAccessPolicy:
      type: object
      title: ClusterAccessPolicy
      required:
        - creator_grant_role
        - max_grant_role
        - elevated_max_ttl_seconds
        - require_reason_from_role
        - is_configured
      properties:
        creator_grant_role:
          type: string
          enum:
            - none
            - view
            - edit
            - admin
            - cluster-admin
          title: Creator Grant Role
        max_grant_role:
          type: string
          enum:
            - view
            - edit
            - admin
            - cluster-admin
          title: Max Grant Role
        elevated_max_ttl_seconds:
          anyOf:
            - type: integer
              minimum: 60
              maximum: 31536000
            - type: 'null'
          title: Elevated Max Ttl Seconds
          description: >-
            The longest a grant above view may last, in seconds: such a grant
            must expire, and no later than this from when it is created or
            re-timed. It is also the window a kube_access.elevate holder may
            give itself (4 hours when null). null sets no bound.
        require_reason_from_role:
          anyOf:
            - type: string
              enum:
                - view
                - edit
                - admin
                - cluster-admin
            - type: 'null'
          title: Require Reason From Role
          description: >-
            The lowest role whose grants must carry a reason. null requires none
            (a kube_access.elevate holder always gives one).
        is_configured:
          type: boolean
          title: Is Configured
    ClusterAccessPolicyProposalPrincipal:
      type: object
      title: ClusterAccessPolicyProposalPrincipal
      required:
        - user_id
        - principal
        - token_id
        - token_name
      properties:
        user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: User Id
        principal:
          type: string
          title: Principal
          description: 'Who proposed: an email, or a service account''s name.'
        token_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Token Id
          description: The token that carried the proposal; null for a browser session.
        token_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Token Name

````

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