GET/api/v1/get-vault-limits

Get a vault's limits

Returns the spending limit configured on one vault, together with its reset cycle and the vault's Bitcoin address.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

This reports the policy as configured: the limit, the cycle period, and the cycle day, with VaultAddress confirming which vault on chain the policy belongs to. CyclePeriod is W for weekly or M for monthly, and CycleDay is the day of the week or the day of the month the vault's usage counter resets on.

Usage is not part of this response. To see how much of the limit has been spent, how much is left, and when the next reset falls, read the vault itself with GET /api/v1/get-vault and look at its detailed_vault_limits. To test one amount against the limit before you propose a movement, use GET /api/v1/check-vault-limit. To change the limit, use POST /api/v1/update-vault. What the limit does when a movement exceeds it is described under Vault policies.

Query parameters

vault_idstringrequired

The vault whose limit to read.

workspace_idnumberrequired

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

bash

curl "$SQRL_API/api/v1/get-vault-limits?vault_id=vault_01HZXB2K7P&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  vault_id: "vault_01HZXB2K7P",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-vault-limits?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Limit, CyclePeriod, CycleDay } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-vault-limits", api_base))
    .query(&[("vault_id", "vault_01HZXB2K7P"), ("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"VaultAddress": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
"Limit": "250000.00",
"CyclePeriod": "M",
"CycleDay": 1
}

Was this page helpful?