POST/api/v1/update-vault

Update a vault's spending policy

Sets a new spending limit and reset cycle on one vault, replacing the policy the vault was created with.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

Despite the name, this call changes the vault's spending policy only: the limit for a movement out of the vault, and the cycle its usage counter resets on. The signer set and the approval threshold are fixed when the vault is created by POST /api/v1/create_wallet, and this endpoint does not alter them, nor the vault's address, name, or network. All five fields are required, so send the current cycle values again when you are only changing the limit. Read the values in force first with GET /api/v1/get-vault-limits.

The new limit applies to the next movement

Vault policies are enforced before the signing stage: a movement that exceeds the limit is blocked and never reaches signers, so it cannot be rescued by an approval. Lowering a limit therefore stops movements the workspace may be expecting to make, and raising one widens what a single proposal can move before anyone signs. Confirm the figure with the people accountable for the vault, and see Vault policies for how the limit and the cycle work together.

Body parameters

vault_idstringrequired

The vault whose policy to update.

workspace_idnumberrequired

The workspace the vault belongs to. You must hold MANAGE_WORKSPACE in it.

transaction_limitstringrequired

The new maximum value for a single movement out of this vault, as a decimal string.

cycle_periodstringrequired

How often the vault's usage counter resets. W for weekly or M for monthly.

cycle_daynumberrequired

The day the counter resets. Day of the week for a weekly cycle, day of the month for a monthly cycle.

bash

curl -X POST "$SQRL_API/api/v1/update-vault" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "vault_id": "vault_01HZXB2K7P",
        "workspace_id": 342,
        "transaction_limit": "180000.00",
        "cycle_period": "M",
        "cycle_day": 1
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/update-vault`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    vault_id: "vault_01HZXB2K7P",
    workspace_id: 342,
    transaction_limit: "180000.00",
    cycle_period: "M",
    cycle_day: 1,
  }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/update-vault", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "vault_id": "vault_01HZXB2K7P",
        "workspace_id": 342,
        "transaction_limit": "180000.00",
        "cycle_period": "M",
        "cycle_day": 1,
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

#What happens next

Read the policy back with GET /api/v1/get-vault-limits to confirm the stored values, and test a representative amount against the new limit with GET /api/v1/check-vault-limit before the desk relies on it. Members see their own headroom through GET /api/v1/get-my-limits, which reports their role limit rather than the vault's.

Was this page helpful?