Update a vault

Update a vault config’s name or provider settings, keeping the stored token.

PATCH /api/v2/vaults/{vault_id}

Python

from hai_agents import Client

client = Client()

vault = client.vaults.update_vault(
    vault_id=vault_id,
    name="prod-1password-eu",
)
print(vault.name)

Behavior

Only the fields you send change. To replace the stored service account token, use Rotate token.

Path parameters

vault_id · string · required

The vault config’s id (UUID).

Request body

name · string

New label for the config.

provider_config · object

Replacement provider settings, in the same shape as on create. provider cannot change: delete the vault and create a new one to switch. For a 1Password vault, the stored token is health-checked against the new op_vault_id before anything is saved.

Response

200 with the updated vault object.

Python

from hai_agents import Client

client = Client()

vault = client.vaults.update_vault(
    vault_id=vault_id,
    name="prod-1password-eu",
)
print(vault.name)

Errors

Status	Cause
400	provider_config.provider differs from the vault’s provider, or 1Password rejected the stored token for the new op_vault_id.
404	Not found, or not in your organization.
409	Another vault in your organization already has this name.
422	Body failed validation.