Skip to main content
GET
Get a specific secret set

Authorizations

Authorization
string
header
required

Authentication requires a Pipecat Cloud Private API token.

Generate a Private API key from your Dashboard (Settings > API Keys > Private > Create key) and include it as a Bearer token in the Authorization header.

Path Parameters

setName
string
required

Name of the secret set to retrieve

Required string length: 3 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

Response

Secret set details, including readiness status

region
string

The region where the secret set is stored

status
enum<string>

Readiness state. pending while provisioning is in flight, ready once the set can be bound to a deploy, failed if provisioning could not complete.

Available options:
pending,
ready,
failed
errorMessage
string

Customer-facing message returned only when status is failed. Generic by design — internal diagnostic details are kept in platform logs.

secrets
object[]