Ctrl+K

List policies

get/api/v2/admin/policy

Query Parameters

  • enterpriseIdstring
    Return Policies that apply to the given Enterprise
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the `nextBatchPrevId` value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • policyIdstring
    Return the Policy with the given id
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • rules.coinarray[string]
    Return Policies with rules that apply to the given coin. When specified multiple times, return policies that apply to all of the given coins.
    Example: btc
  • userIdstring
    Return Policies that apply to the given User
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • walletIdstring
    Return Policies that apply to the given Wallet
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • prevIdstring
    Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

Array of
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
date string <date-time>
label string
latest boolean required
rules array[object] required
id string required
lockDate string <date-time>required
The time at which this rule becomes immutable
mutabilityConstraint string
Specifies whether a BitGo admin can change `lockDate` * `managed` - Not locked, but requires approval from a BitGo admin to change * `permanent` - `lockDate` cannot be changed
Allowed values: managed permanent
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string required
What causes this rule to trigger
Allowed values: advancedWhitelist allTx bitcoinAddressWhitelist coinAddressWhitelist coinAddressBlacklist transactionLimit velocityLimit webhook
conditionOne of
Parameters for the type
action object required
What happens when this rule is triggered
version integer required
enterpriseId string
The Enterprise to which this Policy applies
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletId string
The Wallet to which this Policy applies
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$