API reference · Schema
Secret
objectstringrequiredAlways `secret`: the type of this object
One of
secretidstringrequiredUnique ID (`sec_…`)
ID with prefix sec_
project_idstringrequiredProject it belongs to
ID with prefix prj_
namestringrequiredIts name
created_by_user_idstring | nullrequiredID of the user who created it
created_byobject | nullrequiredWho created it (null: created by the platform)
ShowHide 3 fields of
created_byobjectstringrequiredAlways `person`
One of
personidstringrequiredThe person’s user ID (`usr_…`)
namestring | nullrequiredTheir name as they set it; null when they are no longer a member of the organization
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
Example
{
"object": "secret",
"id": "sec_01jc5zq4m8k3v6x9t2w7r0b1e4",
"project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
"name": "string",
"created_by_user_id": "string",
"created_by": {
"object": "person",
"id": "string",
"name": "string"
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Used by
- List secrets
GET /v1/secrets - Create a secret
POST /v1/secrets - Get a secret (metadata only)
GET /v1/secrets/{secret_id} - Rename a secret or replace its value
PATCH /v1/secrets/{secret_id}