Docs
Reference

Read one secret value

Opens one address and returns its plaintext value over TLS.

GET/api/v1/secrets/{address}

Opens one address and returns its plaintext value over TLS. This is the only place a value leaves the boundary, so it needs secret:reveal rather than the secret:read that lists names.

AuthorizationBearer <token>

A machine credential, sent as Authorization: Bearer pck_.... Issue one from the console, or get a short-lived one from an exchange under auth.

In: header

Path Parameters

address*string

The parameter address. The last segment is the name and everything before it is the path, so slashes are part of the address and are not escaped. A parameter at the root is just its name.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/secrets/db/primary/DATABASE_URL"
{  "value": "string",  "version": -9007199254740991}