Skip to main content
POST
/
rest
/
kill-switch
Kill Switch
curl --request POST \
  --url https://api.exchange.fairx.net/rest/kill-switch \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "only_cancel_no_trading_lock": true,
  "fcm_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "firm_uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "trading_user_uuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}
'
{
  "num_users_affected": 4,
  "num_orders_canceled": 0
}

Authorizations

​
CB-ACCESS-KEY
string
header
required

The key string of the API key for the request

Body

application/json

Kill switch parameters

​
only_cancel_no_trading_lock
boolean
required
​
fcm_uuid
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
firm_uuid
string
Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

​
trading_user_uuid
string
Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

Response

Kill switch executed successfully

​
num_users_affected
integer<int32>
Example:

4

​
num_orders_canceled
integer<int32>
Example:

0