Client SDKSecrets

Retrieve Workspace Secret

Beta
Used to retrieve a Workspace Secret given its ID or name.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Either the Workspace Secret's ID or its unique name

Headers

X-API-VersionstringOptional

Response

idstringformat: "uuid"
modifiedstringformat: "date-time"
namestring<=250 characters
labelstring
secret_typeenum
  • USER_DEFINED - User Defined
  • HMAC - Hmac
  • INTERNAL_API_KEY - Internal Api Key
  • EXTERNALLY_PROVISIONED - Externally Provisioned
Allowed values: