> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akua.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Access a secret version

> Returns the value. Needs `vault.versions.access`: Workspace admins and owners have it on every vault of their Workspace, including the vaults an Install or Offer created for the values they entered; Akua services hold it only where a vault binds them. Every call is audited. POST so that no cache, prefetcher or access log keeps the response.



## OpenAPI

````yaml /openapi-public.json post /vaults/{vault}/secrets/{secret}/versions/{version}:access
openapi: 3.1.0
info:
  title: Akua API
  version: 1.0.0
  description: >-
    Manage installs and their asynchronous operations. Authenticate with a
    session bearer token and select a Workspace using Akua-Context.
  contact:
    name: Akua API support
    email: support@akua.dev
    url: https://docs.akua.dev/
servers:
  - url: https://api.akua.dev/v1
security: []
tags:
  - name: operations
  - name: installs
  - name: Organizations
  - name: Billing accounts
  - name: workspaces
  - name: regions
  - name: Dashboard Overview
  - name: products
  - name: offers
  - name: Order Drafts
  - name: packages
  - name: Auth
  - name: API Tokens
  - name: Quota adjustments
  - name: Workspace services
  - name: Vault connections
  - name: clusters
  - name: Node pools
  - name: Nodes
  - name: machines
  - name: Sandboxes
  - name: OpenCode Servers
  - name: vaults
  - name: vaultSecrets
paths:
  /vaults/{vault}/secrets/{secret}/versions/{version}:access:
    post:
      tags:
        - vaultSecrets
      summary: Access a secret version
      description: >-
        Returns the value. Needs `vault.versions.access`: Workspace admins and
        owners have it on every vault of their Workspace, including the vaults
        an Install or Offer created for the values they entered; Akua services
        hold it only where a vault binds them. Every call is audited. POST so
        that no cache, prefetcher or access log keeps the response.
      operationId: secrets.accessVersion
      parameters:
        - name: vault
          in: path
          schema:
            $ref: '#/components/schemas/VaultId'
          required: true
        - name: secret
          in: path
          schema:
            $ref: '#/components/schemas/SecretId'
          required: true
        - name: version
          in: path
          schema:
            $ref: '#/components/schemas/VersionSelector'
          required: true
        - name: akua-context
          in: header
          schema:
            type: string
            minLength: 1
            maxLength: 53
            description: >-
              Optional workspace/scope context for the request. Carries a single
              workspace wire id (`ws_…`) today. Only needed for broad tokens - a
              workspace-owned token implies its workspace.
            examples:
              - ws_j572abc123def4
          required: false
      responses:
        '200':
          description: AccessSecretVersionResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessSecretVersionResponse'
        '403':
          description: The credential may not act in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiForbidden'
        '404':
          description: The resource was not found in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiNotFound'
        '409':
          description: >-
            The request conflicts with existing resource state or immutable
            intent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiConflict'
        '410':
          description: The resource is permanently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGone'
        '429':
          description: The caller is over its per-minute budget.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiTooManyRequests'
        '503':
          description: The service is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiServiceUnavailable'
      security:
        - BearerAuth: []
components:
  schemas:
    VaultId:
      type: string
      pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
      title: VaultId
      description: >-
        A vault id chosen by its creator, unique in the Workspace. `default` is
        the Workspace vault.
      examples:
        - default
    SecretId:
      type: string
      pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
      title: SecretId
      description: A secret id, unique in its vault
      examples:
        - db-password
    VersionSelector:
      type: string
      pattern: ^(latest|[1-9][0-9]{0,8})$
      title: VersionSelector
      description: A version number or `latest`
      examples:
        - latest
        - '3'
    AccessSecretVersionResponse:
      type: object
      properties:
        name:
          type: string
          description: The resolved version, also when `latest` was asked for.
        payload:
          type: string
      required:
        - name
        - payload
      additionalProperties: false
    ApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Forbidden
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - NotFound
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiConflict:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Conflict
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiGone:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Gone
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiTooManyRequests:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - TooManyRequests
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiServiceUnavailable:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - ServiceUnavailable
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Machine-readable error code
          examples:
            - 7002
        message:
          type: string
          description: Human-readable error message
          examples:
            - Resource not found
        path:
          type: array
          items:
            type: string
          description: Field path that caused the error, when applicable
          examples:
            - - body
              - name
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      description: Bearer token for the authenticated caller.
      type: http
      scheme: bearer

````

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