Dapr

Dapr Secrets API

Secret management operations.

Documentation GitHub OpenAPI

Documentation

https://docs.dapr.io/reference/api/state_api/

https://docs.dapr.io/reference/api/pubsub_api/

https://docs.dapr.io/reference/api/service_invocation_api/

https://docs.dapr.io/reference/api/bindings_api/

https://docs.dapr.io/reference/api/secrets_api/

https://docs.dapr.io/reference/api/actors_api/

https://docs.dapr.io/reference/api/workflow_api/

https://docs.dapr.io/reference/api/configuration_api/

https://docs.dapr.io/reference/api/distributed_lock_api/

https://docs.dapr.io/reference/api/cryptography_api/

https://docs.dapr.io/reference/api/jobs_api/

https://docs.dapr.io/reference/api/health_api/

https://docs.dapr.io/reference/api/metadata_api/

Specifications

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/openapi/dapr-secrets-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/asyncapi/dapr-pubsub-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/state-item.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/cloud-event.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/binding.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/secret.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/actor.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/workflow.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/configuration-item.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/job.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/metadata.json

Other Resources

https://docs.dapr.io/developing-applications/building-blocks/state-management/

Client Libraries

https://docs.dapr.io/sdks/

https://docs.dapr.io/developing-applications/building-blocks/pubsub/

https://docs.dapr.io/developing-applications/building-blocks/service-invocation/

https://docs.dapr.io/developing-applications/building-blocks/bindings/

https://docs.dapr.io/developing-applications/building-blocks/secrets/

https://docs.dapr.io/developing-applications/building-blocks/actors/

https://docs.dapr.io/developing-applications/building-blocks/workflow/

https://docs.dapr.io/developing-applications/building-blocks/configuration/

https://docs.dapr.io/developing-applications/building-blocks/distributed-lock/

https://docs.dapr.io/developing-applications/building-blocks/cryptography/

https://docs.dapr.io/developing-applications/building-blocks/jobs/

https://docs.dapr.io/operations/observability/healthchecks/

https://docs.dapr.io/operations/observability/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Dapr Actors Secrets API
  description: The Dapr Actors API provides virtual actor capabilities for distributed applications, including actor method invocation, state management, timers, and reminders. Actors provide a single-threaded programming model with guaranteed message ordering.
  version: 1.0.0
  contact:
    name: Dapr
    url: https://dapr.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:3500
  description: Dapr Sidecar
tags:
- name: Secrets
  description: Secret management operations.
paths:
  /v1.0/secrets/{secret-store-name}/{name}:
    get:
      summary: Dapr Get Secret
      description: Retrieves a secret from the specified secret store by name. Supports optional per-request metadata such as version_id and version_stage.
      operationId: getSecret
      tags:
      - Secrets
      parameters:
      - name: secret-store-name
        in: path
        required: true
        description: The name of the secret store component.
        schema:
          type: string
      - name: name
        in: path
        required: true
        description: The name of the secret to retrieve.
        schema:
          type: string
      - name: metadata.version_id
        in: query
        description: Version identifier for the secret (supported by Hashicorp Vault, GCP Secret Manager, AWS Secret Manager).
        schema:
          type: string
      - name: metadata.version_stage
        in: query
        description: Version stage for the secret (supported by AWS Secret Manager).
        schema:
          type: string
      - name: metadata.namespace
        in: query
        description: Kubernetes namespace (supported by Kubernetes Secrets).
        schema:
          type: string
      responses:
        '200':
          description: Secret retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '403':
          description: Access denied by secret store access policy.
        '404':
          description: Secret not found.
        '500':
          description: Failed to get secret.
  /v1.0/secrets/{secret-store-name}/bulk:
    get:
      summary: Dapr Get Bulk Secrets
      description: Retrieves all secrets from the specified secret store in a single request.
      operationId: getBulkSecrets
      tags:
      - Secrets
      parameters:
      - name: secret-store-name
        in: path
        required: true
        description: The name of the secret store component.
        schema:
          type: string
      responses:
        '200':
          description: Bulk secrets retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
                  additionalProperties:
                    type: string
        '403':
          description: Access denied by secret store access policy.
        '500':
          description: Failed to get bulk secrets.
externalDocs:
  description: Dapr Actors API Reference
  url: https://docs.dapr.io/reference/api/actors_api/