Dapr

Dapr Cryptography API

Cryptographic 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-cryptography-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 Cryptography 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: Cryptography
  description: Cryptographic operations.
paths:
  /v1.0-alpha1/crypto/{crypto-store-name}/encrypt:
    put:
      summary: Dapr Encrypt
      description: Encrypts data using the specified cryptography component and key. The HTTP API is intended for development and testing; for production, use the gRPC API via SDKs.
      operationId: encrypt
      tags:
      - Cryptography
      parameters:
      - name: crypto-store-name
        in: path
        required: true
        description: The name of the cryptography component.
        schema:
          type: string
      - name: dapr-key-name
        in: header
        required: true
        description: The name of the key to use for encryption.
        schema:
          type: string
      - name: dapr-key-wrap-algorithm
        in: header
        required: true
        description: The key wrap algorithm to use (e.g., A256KW, A128CBC, RSA-OAEP-256).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Data encrypted successfully.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad request or missing parameters.
        '500':
          description: Failed to encrypt data.
  /v1.0-alpha1/crypto/{crypto-store-name}/decrypt:
    put:
      summary: Dapr Decrypt
      description: Decrypts data using the specified cryptography component and key. The HTTP API is intended for development and testing; for production, use the gRPC API via SDKs.
      operationId: decrypt
      tags:
      - Cryptography
      parameters:
      - name: crypto-store-name
        in: path
        required: true
        description: The name of the cryptography component.
        schema:
          type: string
      - name: dapr-key-name
        in: header
        required: true
        description: The name of the key to use for decryption.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Data decrypted successfully.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad request or missing parameters.
        '500':
          description: Failed to decrypt data.
externalDocs:
  description: Dapr Actors API Reference
  url: https://docs.dapr.io/reference/api/actors_api/