FIfireblocks
Policy Editor V2 (Beta)

Calculate the AOT quota for a policy rule

Returns the Amount Over Time (AOT) quota calculated for a specific policy rule.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

post/policy/rules/quota

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

ruleIdstring required

The ID of the policy rule to calculate AOT quota for

initiatorstring

Optional initiator identifier for the AOT calculation

Example request

{
  "ruleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "initiator": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source": {
    "id": "123",
    "type": "VAULT"
  },
  "destination": {
    "id": "123",
    "type": "VAULT"
  }
}

Response

The calculated AOT quota for the rule

amountstring

The calculated Amount Over Time (AOT) quota for the rule

currencystring

The currency of the AOT amount

windowStartnumber

Unix timestamp (seconds) of the start of the current AOT time window

windowEndnumber

Unix timestamp (seconds) of the end of the current AOT time window (when the AOT was calculated)

transactionCountnumber

Number of transactions in the current AOT time window

Example response

{
  "amount": "10000",
  "quotaConfig": {
    "range": {
      "min": "100",
      "max": "10000"
    },
    "currency": "USD",
    "timePeriod": {
      "seconds": "86400",
      "initiator": "PER_SINGLE_MATCH",
      "source": "PER_SINGLE_MATCH",
      "destination": "PER_SINGLE_MATCH"
    }
  },
  "currency": "USD",
  "windowStart": 1699913600,
  "windowEnd": 1700000000,
  "transactionCount": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.