GET/api/v1/check-vault-limit

Check an amount against a vault's limit

Tests whether a proposed amount fits within a vault's spending limit, returning true when it does and changing nothing either way.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

Use this to tell someone that a movement will be refused before they build it. The response is a single boolean: Success is true when the amount fits within the vault's policy and false when it does not. Note the parameter name: transaction_limit carries the amount you want to test, not a new limit, and this call never writes anything. To change the vault's limit, use POST /api/v1/update-vault; to read it, use GET /api/v1/get-vault-limits.

Vault policies are enforced before the signing stage, which is why the check is worth making: a movement that exceeds the limit is blocked and never reaches signers, so no amount of approval will push it through. See Vault policies.

A true result is not a reservation

This is a pre-flight check against the state of the vault at the moment you ask. Nothing is held back or set aside for you, so another movement approved in the meantime, or a cycle reset, can change the answer. Treat true as "this would be accepted now", not as a guarantee that a later proposal will pass.

Query parameters

vault_idstringrequired

The vault the amount would move out of.

workspace_idnumberrequired

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

transaction_limitstringrequired

The amount to test against the vault's limit, as a decimal string. This is the proposed movement value, not a new limit.

bash

curl "$SQRL_API/api/v1/check-vault-limit?vault_id=vault_01HZXB2K7P&workspace_id=342&transaction_limit=42500.00" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  vault_id: "vault_01HZXB2K7P",
  workspace_id: "342",
  transaction_limit: "42500.00",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/check-vault-limit?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Success } = await res.json();

rust

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

Response200 OK

{
"Success": true
}

Was this page helpful?