Skip to main content
PUT
Set a secret

Authorizations

Authorization
string
header
required

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

Path Parameters

name
string
required

Secret name. It starts with a letter or number and contains only letters, numbers, underscores, and dashes, up to 128 characters. Surrounding whitespace is ignored.

Pattern: ^[\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]*[A-Za-z0-9][A-Za-z0-9_-]{0,127}[\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]*$

Body

application/json
value
string
required

Value to store. It must be one line of text and at most 64 KiB as UTF-8. Sail never returns it after this request.

Required string length: 1 - 65536
Pattern: ^[^\u0000-\u001f\u007f]+$

Response

The secret metadata.

org_id
string
required

Organization that owns the secret.

name
string
required

Name used in HTTP policy references. The secret value is never returned.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
created_at
string<date-time>
required

When the secret was first created.

updated_at
string<date-time>
required

When the secret value was last replaced.