Sign in
Vaults

Update a vault

Updates the name or metadata of an active vault. Omitted fields remain unchanged. See vaults.

post/vaults/{vault_id}

Path parameters

vault_idstring required

The ID of the vault.

Request body

metadataobject

Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.

namestring nullable

A replacement name. Omit to leave unchanged, or pass null to clear it. The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.

Response

The updated vault.

idstring required

The ID of the vault.

object'vault' required

The object type. Always vault.

namestring nullable required

The human-readable name of the vault, if set.

metadataobject required

Key-value pairs associated with the vault, such as an application or team identifier.

created_atinteger required

The Unix timestamp, in seconds, when the vault was created.

Changes

Changed in 1 of the 242 revisions of this API.1