Skip to main content
cURL
curl --request GET \
  --url https://test.deribit.com/api/v2/private/edit_api_key \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 2453,
  "method": "private/edit_api_key",
  "params": {
    "name": "NewKeyName",
    "max_scope": "account:read_write wallet:read_write block_trade:read trade:read_write",
    "id": 3
  }
}
'
{
  "jsonrpc": "2.0",
  "id": 2453,
  "result": {
    "timestamp": 1560242482758,
    "max_scope": "account:read_write block_trade:read trade:read_write wallet:read_write",
    "id": 3,
    "enabled": true,
    "default": false,
    "client_secret": "B6RsF9rrLY5ezEGBQkyLlV-UC7whyPJ34BMA-kKYpes",
    "client_id": "1sXMQBhM",
    "name": "NewKeyName"
  }
}

Query Parameters

​
id
integer
required

API key ID

Example:

1

​
max_scope
string[]
required

Describes maximal access for tokens generated with given key. If scope is not provided, its value is set as none. Please check details described in Access scope

Example:
[
  "account:read",
  "trade:read",
  "block_trade:read_write",
  "wallet:none"
]
​
name
string

Name of key (only letters, numbers and underscores allowed; maximum length - 16 characters)

Example:

"TestName"

​
enabled
boolean

Enables/disables the API key. true to enable, false to disable

​
enabled_features
enum<string>[]

List of enabled advanced on-key features. Available options:

  • restricted_block_trades: Limit the block_trade read the scope of the API key to block trades that have been made using this specific API key
  • block_trade_approval: Block trades created using this API key require additional user approval. Methods that use block_rfq scope are not affected by Block Trade approval feature
Available options:
restricted_block_trades,
block_trade_approval
​
ip_whitelist
string[]

Whitelist provided IP address on a selected key

Response

200 - application/json

Success response

​
jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
​
result
object
required
​
id
integer

The id that was sent in the request