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

# Create or rotate a reviewed credential value

> Requires the applications rollout and live organisation membership. Metadata reads require applications.read; writes require applications.write, intersected with live PAT scope. Browser mutations require CSRF. No secret values or store paths are returned; all responses are no-store. This registry operation does not connect or restart a workload. expected_value_id is required: null requires no active value; otherwise it must match the current active value. A repeated or concurrent stale request cannot replace a newer value. Successful rotation retires the previous value, revokes its grants and returns replacement grant metadata. Store acknowledgement must identify immutable version one. After an uncertain response reload family metadata and review the current value before another write.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/service-admission/credentials/{family_id}/values
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/credentials/{family_id}/values:
    post:
      tags:
        - Services
      summary: Create or rotate a reviewed credential value
      description: >-
        Requires the applications rollout and live organisation membership.
        Metadata reads require applications.read; writes require
        applications.write, intersected with live PAT scope. Browser mutations
        require CSRF. No secret values or store paths are returned; all
        responses are no-store. This registry operation does not connect or
        restart a workload. expected_value_id is required: null requires no
        active value; otherwise it must match the current active value. A
        repeated or concurrent stale request cannot replace a newer value.
        Successful rotation retires the previous value, revokes its grants and
        returns replacement grant metadata. Store acknowledgement must identify
        immutable version one. After an uncertain response reload family
        metadata and review the current value before another write.
      operationId: rotateServiceCredentialToken
      parameters:
        - name: family_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceCredentialValueRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceCredentialRotation'
        '401':
          description: Authentication required
        '403':
          description: Permission or CSRF denied
        '404':
          description: Unknown, foreign, or rollout-disabled resource
        '409':
          description: Credential state changed or requested value is unavailable
        '422':
          description: Invalid or ambiguous request; submitted values are never echoed
        '429':
          description: Organisation quota or a pending family write prevents another value
        '500':
          description: Internal or uncertain write outcome; reload metadata before retrying
        '503':
          description: Credential store unavailable or rollout could not be verified
      security:
        - BearerAuth: []
components:
  schemas:
    ServiceCredentialValueRequest:
      type: object
      additionalProperties: false
      required:
        - value
        - expected_value_id
      properties:
        value:
          type: string
          minLength: 1
          maxLength: 65536
          writeOnly: true
        expected_value_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
    ServiceCredentialRotation:
      type: object
      additionalProperties: false
      required:
        - value
        - replaced
        - granted
      properties:
        value:
          $ref: '#/components/schemas/ServiceCredentialValue'
        replaced:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCredentialGrant'
        granted:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCredentialGrant'
    ServiceCredentialValue:
      type: object
      additionalProperties: false
      required:
        - id
        - state
        - created_at
        - activated_at
        - retired_at
        - retained
      properties:
        id:
          type: string
          format: uuid
        state:
          type: string
          enum:
            - pending
            - active
            - retired
            - failed
            - deleted
        created_at:
          type: string
          format: date-time
        activated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        retired_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        retained:
          type: boolean
    ServiceCredentialGrant:
      type: object
      additionalProperties: false
      required:
        - id
        - value_id
        - package_digest
        - input_name
        - mode
        - created_at
        - revoked_at
      properties:
        id:
          type: string
          format: uuid
        value_id:
          type: string
          format: uuid
        package_digest:
          type: string
        input_name:
          type: string
        mode:
          type: string
          enum:
            - hosted
            - customer
            - existing
        created_at:
          type: string
          format: date-time
        revoked_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````