Session Keys
private/edit_session_key
Updates an existing session key’s label, IP allowlist, and/or off-chain scopes for a given wallet; it cannot change on-chain (protocol) scopes, for which you must re-register with private/set_session_key. Editing only the label needs account-info permission, while changing the IP allowlist or off-chain scopes requires admin/owner authorization. Returns the updated session key details.
POST
/
private
/
edit_session_key
private/edit_session_key
curl --request POST \
--url https://api.derive.xyz/v3/private/edit_session_key \
--header 'Content-Type: application/json' \
--data '
{
"public_session_key": "<string>",
"wallet": "<string>",
"ip_whitelist": null,
"label": null,
"offchain_scopes": null
}
'import requests
url = "https://api.derive.xyz/v3/private/edit_session_key"
payload = {
"public_session_key": "<string>",
"wallet": "<string>",
"ip_whitelist": None,
"label": None,
"offchain_scopes": None
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
public_session_key: '<string>',
wallet: '<string>',
ip_whitelist: null,
label: null,
offchain_scopes: null
})
};
fetch('https://api.derive.xyz/v3/private/edit_session_key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.derive.xyz/v3/private/edit_session_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'public_session_key' => '<string>',
'wallet' => '<string>',
'ip_whitelist' => null,
'label' => null,
'offchain_scopes' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.derive.xyz/v3/private/edit_session_key"
payload := strings.NewReader("{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/private/edit_session_key")
.header("Content-Type", "application/json")
.body("{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/edit_session_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}"
response = http.request(request)
puts response.read_body{
"expiry_sec": 1,
"ip_whitelist": [
"<string>"
],
"label": "<string>",
"offchain_scopes": [
"<string>"
],
"protocol_scopes": [
"<string>"
],
"public_session_key": "<string>",
"registered_sec": 1,
"subaccount_ids": [
1
]
}Body
application/json
Response
Success
Required range:
x >= 0Off-chain scopes (read-tier capabilities).
Protocol-level (on-chain authority) scopes.
Required range:
x >= 0Subaccounts this key may act on. An empty stored value means "all subaccounts" and is expanded to the wallet's current subaccount list.
Required range:
x >= 0private/edit_session_key
curl --request POST \
--url https://api.derive.xyz/v3/private/edit_session_key \
--header 'Content-Type: application/json' \
--data '
{
"public_session_key": "<string>",
"wallet": "<string>",
"ip_whitelist": null,
"label": null,
"offchain_scopes": null
}
'import requests
url = "https://api.derive.xyz/v3/private/edit_session_key"
payload = {
"public_session_key": "<string>",
"wallet": "<string>",
"ip_whitelist": None,
"label": None,
"offchain_scopes": None
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
public_session_key: '<string>',
wallet: '<string>',
ip_whitelist: null,
label: null,
offchain_scopes: null
})
};
fetch('https://api.derive.xyz/v3/private/edit_session_key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.derive.xyz/v3/private/edit_session_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'public_session_key' => '<string>',
'wallet' => '<string>',
'ip_whitelist' => null,
'label' => null,
'offchain_scopes' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.derive.xyz/v3/private/edit_session_key"
payload := strings.NewReader("{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/private/edit_session_key")
.header("Content-Type", "application/json")
.body("{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/edit_session_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_session_key\": \"<string>\",\n \"wallet\": \"<string>\",\n \"ip_whitelist\": null,\n \"label\": null,\n \"offchain_scopes\": null\n}"
response = http.request(request)
puts response.read_body{
"expiry_sec": 1,
"ip_whitelist": [
"<string>"
],
"label": "<string>",
"offchain_scopes": [
"<string>"
],
"protocol_scopes": [
"<string>"
],
"public_session_key": "<string>",
"registered_sec": 1,
"subaccount_ids": [
1
]
}