Skip to main content
POST
Create Secret

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

2-64 characters: lowercase letters, digits, '-' and '_', starting and ending with a letter or digit. Prefixes the platform uses for its own secrets are rejected.

value
string
required

Stored encrypted; never returned.

Minimum string length: 1
description
string | null
Maximum string length: 1000

Response

Successful Response

A secret's metadata. The value is never part of this.

id
string<uuid>
required
name
string
required

Unique within the workspace.

created_at
string | null
description
string | null
updated_at
string | null
used_by
SecretConsumer · object[]