Update Key

Updates a Fast API key.

Scopes required: account.fast-api-key:write

PUT /fast-api-key

Update Key

cURL

curl --request PUT \
  --url https://api.kraken.com/oauth/fast-api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_api_key_name": "<string>",
  "api_key_name": "<string>",
  "ip_allowlist": [
    "<string>"
  ],
  "nonce_window": 1,
  "permissions": {
    "export_data": true,
    "funds_add": true,
    "funds_earn": true,
    "funds_query": true,
    "funds_withdraw": true,
    "ledger_query": true,
    "trades_close": true,
    "trades_modify": true,
    "trades_query_closed": true,
    "trades_query_open": true
  },
  "query_from": 123,
  "query_to": 123,
  "valid_until": 123
}
'

200

{
  "result": true
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

new_api_key_name · string | null

New API key description

Maximum string length: 32

api_key_name · string

API key description

Required string length: 1 - 32

ip_allowlist · string[]

IP allowlist for the API key, supports CIDR notation for IPv4 and IPv6.

nonce_window · number | null

Nonce amount to accept from highest nonce

Required range: x >= 0

permissions · object

What this API key can and can't do

Show child attributes

query_from · number | null

Unix timestamp indicating allowable starting time for queries, or 0 if no restriction

query_to · number | null

Unix timestamp indicating allowable ending time for queries, or 0 if no restriction

valid_until · number | null

Unix timestamp indicating when key expires, or 0 if no expiration

Response

200 - application/json

Success response

result · boolean · default: true