List business rules

get

https://your-protect-instance.example.com/api/rest/v2/businessrules

This endpoint returns a list of business rules.
Required role: Admin or AdminReadOnly.

Query Params

ids

array of strings

ids

ruleKeys

array of strings

ruleKeys

ruleGroups

array of strings

ruleGroups

walletIds

array of strings

Deprecated - Use EntityType and EntityID instead

walletIds

currencyIds

array of strings

Filter on currency ids

currencyIds

addressIds

array of strings

Deprecated - Use EntityType and EntityID instead

addressIds

level

string

Deprecated - Use EntityType instead

one of '', 'global', 'currency', 'address', 'wallet'

cursor.currentPage

string

Base64-encoded string representing the current window of data

cursor.pageRequest

string

The page to request, w.r.t the current page.
Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSize

string

The size of the page requested. The handling service should impose a hard limit on this

entityType

string

Filters rules by what they apply to. This can be one of global, currency, wallet, address, exchange, exchange_account, tn_participant.

entityIDs

array of strings

Filters rules by the identifier of the affected entity. For wallets, addresses, and currencies this is their ID. For exchanges this is the exchange label. Leave this field blank for global rules.

entityIDs

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.