Skip to main content
Manage secrets: named credentials that workflows can reference. A secret’s value can be set and rotated but is never returned by the API.

​
The secret object

A secret is a named credential that workflows can reference, for example an auth token for an outgoing webhook.

Its value can be set and rotated but never read back: the API stores it encrypted and only ever returns masked metadata (the last four characters of the current value). Update the value with the rotate action, which appends a new version and retires the previous one.

​
created_at
string<date-time>
required
Example:

"2021-08-17T13:28:57.801578Z"

​
id
string
required

Unique identifier for this secret

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
name
string
required

Human-readable name, unique within the organisation amongst unarchived secrets

Example:

"PagerDuty webhook token"

​
owning_team_ids
string[]
required

IDs of the teams that own this secret. Empty means the secret is owned by the whole organisation.

Example:
​
updated_at
string<date-time>
required
Example:

"2021-08-17T13:28:57.801578Z"

​
version
integer<int64>
required

The current version number, incremented on each rotation

Example:

3

​
description
string

Optional description of what this secret is for

Example:

"Auth token for the PagerDuty outgoing webhook"

​
last_four_chars
string

The last four characters of the current value, for masked display. Absent when the value is four characters or shorter.

Example:

"c123"