Skip to main content
PATCH
/
v2
/
wallets
/
risk
/
rules
/
{riskRuleId}
Update Risk Rule
curl --request PATCH \
  --url https://sandbox.groundtech.co/v2/wallets/risk/rules/{riskRuleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "paused"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portfolioWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "yieldSourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "thresholdValue": 123,
    "windowSeconds": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
riskRuleId
string<uuid>
required

Body

application/json
​
name
string | null
​
metric
enum<string>

Global risk metric currently supported across yield sources.

Available options:
apy_bps,
tvl_usd,
available_withdrawal_liquidity_usd
​
ruleKind
enum<string>
Available options:
absolute,
relative_change_bps
​
comparator
enum<string>
Available options:
lt,
lte,
gt,
gte
​
thresholdValue
number
​
windowSeconds
integer | null
​
severity
enum<string>
Available options:
warning,
critical
​
action
enum<string>
Available options:
alert_only,
block_rebalance_buy,
request_rebalance_out,
auto_rebalance_out
​
status
enum<string>
Available options:
active,
paused

Response

Risk rule updated

​
data
object