Skip to main content
POST
/
v1
/
client
/
set_orderly_key_ip_restriction
Set Orderly key IP restriction
curl --request POST \
  --url https://api.orderly.org/v1/client/set_orderly_key_ip_restriction \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "data": {
    "ip_restriction_list": [
      "192.168.0.1-192.168.0.10"
    ]
  },
  "timestamp": 1702989203989
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

​
orderly_key
string
required

The orderly key to set the IP restriction list.

​
ip_restriction_list
string
required

List of IP addresses or IP ranges, comma separated, that are allowed to use the orderly_key.

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989