> ## 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. # Get a secret > Metadata only. ## OpenAPI ````yaml /openapi-public.json get /vaults/{vault}/secrets/{secret} 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}: get: tags: - vaultSecrets summary: Get a secret description: Metadata only. operationId: secrets.get parameters: - name: vault in: path schema: $ref: '#/components/schemas/VaultId' required: true - name: secret in: path schema: $ref: '#/components/schemas/SecretId' 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: Secret content: application/json: schema: $ref: '#/components/schemas/Secret' '400': description: The request is malformed. content: application/json: schema: $ref: '#/components/schemas/ApiBadRequest' '401': description: Missing, invalid or expired credential. content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorized' '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' '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 Secret: type: object properties: name: type: string description: Resource name `vaults/{vault}/secrets/{secret}`. examples: - vaults/default/secrets/db-password vault_id: $ref: '#/components/schemas/VaultId' secret_id: $ref: '#/components/schemas/SecretId' labels: type: object patternProperties: ^[a-z][a-z0-9_-]{0,62}$: type: string maxLength: 63 additionalProperties: false maxProperties: 64 latest_version: anyOf: - type: integer - type: 'null' version_count: type: integer created_at: type: integer minimum: 0 description: Unix timestamp (seconds) updated_at: type: integer minimum: 0 description: Unix timestamp (seconds) etag: type: string maxLength: 64 description: Pass as `If-Match` on writes. OUTPUT_ONLY. required: - name - vault_id - secret_id - labels - latest_version - version_count - created_at - updated_at - etag additionalProperties: false ApiBadRequest: type: object properties: _tag: type: string enum: - Validation 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 ApiUnauthorized: type: object properties: _tag: type: string enum: - Unauthorized 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 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 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.