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

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/edit_session_key
  • Auth: none declared

Request body

ip_whiteliststring[] nullable
labelstring nullable

Send null to clear the label; omit the field to leave it unchanged.

offchain_scopesstring[] nullable
public_session_keystring required
walletstring required

Response

Success

expiry_secinteger required
ip_whiteliststring[] required
labelstring required
offchain_scopesstring[] required

Off-chain scopes (read-tier capabilities).

protocol_scopesstring[] required

Protocol-level (on-chain authority) scopes.

public_session_keystring required
registered_secinteger required
subaccount_idsinteger[] required

Subaccounts this key may act on. An empty stored value means "all subaccounts" and is expanded to the wallet's current subaccount list.

Changes

No recorded changes to this operation across all 1 revision of this API.