Throttle

Try to turn on throttle mode

post

/start_throttle

Body

Represents the throttle reqwest

namestringRequired

The name of the key.

secretstringRequired

The secret associated with this key.

Responses

200

Throttle started successfully

application/json

Represents the current sBTC limits.

availableToWithdrawinteger · int64 · nullableOptional

Total amount sBTC still available for withdrawals in current window. All withdrawals except rejected counted here

pegCapinteger · int64 · nullableOptional

Represents the total cap for all pegged-in BTC/sBTC.

perDepositCapinteger · int64 · nullableOptional

Per deposit cap. If none then there is no cap.

perDepositMinimuminteger · int64 · nullableOptional

Per deposit minimum. If none then there is no minimum.

perWithdrawalCapinteger · int64 · nullableOptional

Per withdrawal cap. If none then there is no cap.

rollingWithdrawalBlocksinteger · int64 · nullableOptional

Number of blocks that define the rolling withdrawal window.

rollingWithdrawalCapinteger · int64 · nullableOptional

Maximum total sBTC that can be withdrawn within the rolling withdrawal window.

throttleModeInitiatorstring · nullableOptional

Name of key which triggered throttle mode (if throttle mode is active)

403

Key is revoked

application/json

404

Throttle key not found

application/json

500

Internal server error

application/json

post/start_throttle

POST /start_throttle HTTP/1.1
Host: localhost:3031
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "secret": "text"
}

{
  "accountCaps": {
    "ANY_ADDITIONAL_PROPERTY": {
      "pegCap": 1,
      "perDepositCap": 1,
      "perDepositMinimum": 1,
      "perWithdrawalCap": 1,
      "rollingWithdrawalBlocks": 1,
      "rollingWithdrawalCap": 1,
      "throttleModeInitiator": "text"
    }
  },
  "availableToWithdraw": 1,
  "pegCap": 1,
  "perDepositCap": 1,
  "perDepositMinimum": 1,
  "perWithdrawalCap": 1,
  "rollingWithdrawalBlocks": 1,
  "rollingWithdrawalCap": 1,
  "throttleModeInitiator": "text"
}