Sign in

v2

latestOpenAPI 3.0.02026-07-311824171.4 MB
Account Management
Private

Updates properties of an existing API key. You can modify the key name, scope, enabled status, features, and IP whitelist. At least one parameter must be provided.

Changes take effect immediately. If you modify the scope, the API key will only have access to the newly specified permissions.

TFA required

📖 Related Articles:

Scope: account:read_write

Try in API console

get/private/edit_api_key

Query parameters

idinteger required
Example:1

API key ID

max_scopestring[] required

Describes maximal access for tokens generated with given key. If scope is not provided, its value is set as none.

📖 Related Article: Access Scope

Describes maximal access for tokens generated with given key. If scope is not provided, its value is set as none.

📖 Related Article: Access Scope

[
  "account:read",
  "trade:read",
  "block_trade:read_write",
  "wallet:none"
]
namestring
Example:TestName

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

enabledboolean

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

enabled_featuresstring[]

List of enabled advanced on-key features. Available options:<br> - 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<br> - 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<br>

ip_whiteliststring[]

Whitelist provided IP address on a selected key

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "id": 1,
    "timestamp": 1536569522277,
    "client_id": "IY2D68DS",
    "client_secret": "P9Z_c73KaBPwpoTVfsXzehAhjhdJn5kM7Zlz_hhDhE8",
    "public_key": "-----BEGIN PUBLIC KEY----- MCowBQYDK2VwAyEApajFN0CSwIaaiIRPiFbiYYvpsLQLSccSLLsKPe984sc= -----END PUBLIC KEY-----",
    "max_scope": [
      "account:read",
      "trade:read",
      "block_trade:read_write",
      "wallet:none"
    ],
    "enabled": true,
    "name": "TestName"
  }
}