Skip to content

secrets_api.md

Latest commit

 

History

History
73 lines (50 loc) · 1.7 KB

secrets_api.md

File metadata and controls

73 lines (50 loc) · 1.7 KB

Secrets API Specification

Endpoints

Get Secret

This endpoint lets you get the key-identified value of secret for a given secret store.

HTTP Request

GET http://localhost:<daprPort>/v1.0/secrets/<secret-store-name>/<key>

URL Parameters

Parameter Description
daprPort the Dapr port
secret-store-name the name of the secret store to get the secret from
key the key identifying the name of the secret to get

Query Parameters

Some secret stores have optional metadata properties. metadata is populated using query parameters:

GET http://localhost:<daprPort>/v1.0/secrets/<secret-store-name>/<key>?metadata.version_id=15
GCP Secret Manager

The following optional meta can be provided to the GCP Secret Manager component

Query Parameter Description
metadata.version_id version for the given secret key
AWS Secret Manager

The following optional meta can be provided to the AWS Secret Manager component

Query Parameter Description
metadata.version_id version for the given secret key
metadata.version_stage version stage for the given secret key

Request Body

JSON-encoded value

HTTP Response

Response Codes

Code Description
200 OK
204 Secret not found
400 Secret store is missing or misconfigured
500 Failed to get secret

Examples

curl http://localhost:3500/v1.0/secrets/vault/db-secret \
  -H "Content-Type: application/json"
curl http://localhost:3500/v1.0/secrets/vault/db-secret?metadata.version_id=15&metadata.version_stage=AAA \
  -H "Content-Type: application/json"