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

# Replace a secret slot value

> Replaces the slot's value in place. The slot keeps its id, so every ${SECRET_SLOT:<slot_id>} reference stays valid; its label, hint and expiry do not change. Send exactly one of value or generate. The value is never returned.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/secret-slots/{slot_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: 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/secret-slots/{slot_id}:
    put:
      tags:
        - Secret Slots
      summary: Replace a secret slot value
      description: >-
        Replaces the slot's value in place. The slot keeps its id, so every
        ${SECRET_SLOT:<slot_id>} reference stays valid; its label, hint and
        expiry do not change. Send exactly one of value or generate. The value
        is never returned.
      operationId: replace_secret_slot_api_v1_org_secret_slots__slot_id__put
      parameters:
        - in: path
          name: slot_id
          required: true
          description: >-
            The secret slot's id, the <slot_id> in its ${SECRET_SLOT:<slot_id>}
            sentinel.
          schema:
            title: Slot Id
            type: string
            format: uuid
        - 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretSlotReplaceRequest'
      responses:
        '200':
          description: The slot after the replacement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretSlotResponse'
        '400':
          description: >-
            The body sends both value and generate, or neither, or the new value
            or generate settings break a slot rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
        '401':
          description: Unknown, expired or revoked token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
        '403':
          description: >-
            The organisation header names an organisation the token cannot act
            in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
        '404':
          description: No secret slot with this id in the organisation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
        '422':
          description: slot_id is not a UUID, the body is not valid JSON, or value is empty
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    SecretSlotReplaceRequest:
      title: SecretSlotReplaceRequest
      description: Send exactly one of value or generate.
      oneOf:
        - title: SecretSlotReplaceValue
          type: object
          properties:
            value:
              type: string
              description: The new secret value.
              minLength: 1
          required:
            - value
        - title: SecretSlotReplaceGenerate
          type: object
          properties:
            generate:
              $ref: '#/components/schemas/SecretSlotGenerate'
          required:
            - generate
    SecretSlotResponse:
      title: SecretSlotResponse
      type: object
      description: A secret slot without its value, which is never returned.
      properties:
        slot_id:
          type: string
          format: uuid
        label:
          type: string
          description: The slot's name, unique in the organisation.
        hint:
          anyOf:
            - type: string
            - type: 'null'
          description: A note about what the secret is for, or null.
        created_at:
          type: string
          format: date-time
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the slot expires, or null when it does not.
        last_accessed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the value was last read, or null.
        access_count:
          type: integer
          description: How many times the value has been read.
        sentinel:
          type: string
          description: '${SECRET_SLOT:<slot_id>}: put this where the value belongs.'
        created_via:
          type: string
          enum:
            - user
            - generated
          description: >-
            user when a person supplied the current value, generated when Ankra
            created it.
        pinned_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the slot was pinned so it does not expire, or null.
        references:
          type: array
          items:
            $ref: '#/components/schemas/SecretSlotReference'
          description: The live resources that carry the sentinel.
        created_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The user who created the slot, or null when unknown.
      required:
        - slot_id
        - label
        - hint
        - created_at
        - expires_at
        - last_accessed_at
        - access_count
        - sentinel
        - created_via
        - pinned_at
        - references
        - created_by_user_id
    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
    SecretSlotGenerate:
      title: SecretSlotGenerate
      type: object
      description: Have Ankra create a random value that nobody sees.
      properties:
        length:
          type: integer
          minimum: 16
          maximum: 96
          default: 32
          description: How many random characters to create.
        prefix:
          type: string
          description: >-
            Text to put in front of the random characters, at most 16 characters
            and no whitespace.
          maxLength: 16
    SecretSlotReference:
      title: SecretSlotReference
      type: object
      description: A live resource that carries the slot's sentinel.
      properties:
        cluster_id:
          type: string
          format: uuid
        cluster_name:
          type: string
        resource_id:
          type: string
          format: uuid
        resource_kind:
          type: string
        resource_name:
          type: string
        document_path:
          type: string
          description: Where in the resource the sentinel appears.
        last_seen_at:
          type: string
          format: date-time
      required:
        - cluster_id
        - cluster_name
        - resource_id
        - resource_kind
        - resource_name
        - document_path
        - last_seen_at
    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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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