Update Prime API User Key

Updates the whitelisted IPs for a Prime API user key.

POST /0/private/UpdatePrimeApiUserKey

Update Prime API User Key

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/UpdatePrimeApiUserKey \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "user_id": "2T0RXL9B8K5D6",
  "key_id": "3RM9K4ZTC0C00",
  "whitelisted_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ]
}
'

import requests

url = "https://api.kraken.com/0/private/UpdatePrimeApiUserKey"

payload = {
    "nonce": 123,
    "user_id": "2T0RXL9B8K5D6",
    "key_id": "3RM9K4ZTC0C00",
    "whitelisted_ips": ["192.168.1.1", "10.0.0.1"]
}
headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    nonce: 123,
    user_id: '2T0RXL9B8K5D6',
    key_id: '3RM9K4ZTC0C00',
    whitelisted_ips: ['192.168.1.1', '10.0.0.1']
  })
};

fetch('https://api.kraken.com/0/private/UpdatePrimeApiUserKey', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kraken.com/0/private/UpdatePrimeApiUserKey"

	payload := strings.NewReader("{\n  \"nonce\": 123,\n  \"user_id\": \"2T0RXL9B8K5D6\",\n  \"key_id\": \"3RM9K4ZTC0C00\",\n  \"whitelisted_ips\": [\n    \"192.168.1.1\",\n    \"10.0.0.1\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

{
  "result": {
    "id": "3RM9K4ZTC0C00",
    "api_key": "KRA5L19LAW8Z",
    "user_id": "2T0RXL9B8K5D6",
    "permissions": [
      "read::marketdata"
    ],
    "whitelisted_ips": [
      "192.168.1.1"
    ],
    "updated_at": 123
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

{
  "error": [
    "<string>"
  ]
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

user_id · string · required

The unique identifier of the API user who owns the key.

Example:

"2T0RXL9B8K5D6"

key_id · string · required

The unique identifier of the API key to update.

Example:

"3RM9K4ZTC0C00"

whitelisted_ips · string[]

IP addresses to whitelist for this key.

Example:

["192.168.1.1", "10.0.0.1"]

Response

200

application/json

API user key updated.

Response containing the updated Prime API user key.

result · object · required

Show child attributes

error · string[] · required

Kraken API error