Skip to navigation
API ReferenceSub Account

Reset sub-account API key

Reset the API key of a sub-account, updating its note, permissions, and IP whitelist. Applies only to master accounts and only to sub-account API keys created by the master account.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
subAcctstringRequired

Sub-account name.

apiKeystringRequired

API public key of the sub-account.

labelstringOptional
API key note. If not provided, the existing note is retained.
permstringOptional

API key permissions, separated by comma. read_only: Read; trade: Trade. If not provided, the existing permissions are retained.

ipstringOptional

Linked IP addresses, separated by comma (up to 20). If not provided, the existing IP whitelist is retained.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional