Account Management
Private

Updates the display name for an API key. The name is used for identification purposes in the API key list and does not affect the key's functionality or permissions.

📖 Related Article: Creating new API key on Deribit

Scope: account:read_write

Try in API console

get/private/change_api_key_name

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/change_api_key_name
  • Auth
    none declared

Query parameters

idinteger required
Example:1

API key ID

namestring required
Example:TestName

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

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"
  }
}

Changes

No recorded changes to this operation across all 11 revisions of this API.