Skip to main content
POST
Create a vault
See the vaults guide for SDK and CLI examples.

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

1-128 letters, digits, _ or -, starting with a letter or digit. Unique within your team.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$
description
string
default:""

Trimmed before it's stored.

Maximum string length: 1024
source
Stored · object

Where values come from. Defaults to {"type": "stored"}. The type can't change later.

entries
object

Environment variable name to entry: secrets for a stored vault, item fields for a 1Password vault (otherwise 400 VAULT_ENTRY_INVALID). Keys are environment variable names: letters, digits and _, not starting with a digit, at most 256 characters. A vault holds at most 32 entries (otherwise 409 VAULT_ENTRY_LIMIT_REACHED).

Example:

Response

Success

A named set of environment variables. Holds no values.

id
string<uuid>
required
name
string
required

1-128 letters, digits, _ or -, starting with a letter or digit. Unique within your team.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$
description
string
required
Maximum string length: 1024
entries
object
required

Environment variable name to entry.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
source
object

Where the vault's values come from. stored: your secrets. 1password: a linked 1Password vault, read with the service account token in tokenSecret. Treat a missing source as stored.