Edit Sub-Account API KEY

Info

• This endpoint requires signature. For specific signature rules, please refer to Authentication
• This endpoint will trigger rate limit. For specific rules, please refer to Rate Limit.

Reminder

• This endpoint can only be accessed using the ACCESS ID of the main account
• API Administrative Permission is required for the sub-account before it can edit APIKEY.

HTTP request

POST /account/subs/edit-api

Request parameters

Parameter Name	Required	Type	Notes
sub_user_name	true	string	Sub-account username
api_id	true	int	Unique ID for API KEY
trade_enabled	false	bool	Whether the API KEY has trading permissions
ip_whitelist	false	[]string	The IP whitelist bound to API KEY. Up to 50 IPs can be bound.
remark	false	string	API KEY note. The length of the note cannot exceed 50 characters.

Return parameters

Parameter Name	Type	Notes
api_id	int	Unique ID for API KEY.
created_at	int	Data creation time
access_id	string	access_id of the key pair
secret_key	string	secret_key of the key pair
ip_whitelist	[]string	The IP whitelist bound to API KEY.
trade_enabled	bool	Whether the API KEY has trading permissions.
withdraw_enabled	bool	Whether the API KEY has withdrawal permissions.
is_expired	bool	Whether the API KEY has expired. If the IP whitelist has been bound, the API KEY will never expire. If the IP whitelist is not bound, the API KEY is valid for three months.
expires_at	int	Expiration time of API KEY. 0 means the API KEY is permanently valid.
remark	string	API KEY note

---

Request example

{
    "sub_user_name": "sub1",
    "api_id": 554,
    "can_trade": true,
    "ip_whitelist": [
        "1.1.1.1",
        "1.1.1.2"
    ],
    "remark": "test"
}

Response example

{
    "code": 0,
    "data": {
        "api_id": 554,
        "created_at": 1642145331234,
        "access_id": "xxxxxxxxxx",
        "secret_key": "xxxxxx",
        "ip_whitelist": [
            "1.1.1.1",
            "1.1.1.2"
        ],
        "trade_enabled": true,
        "withdraw_enabled": false,
        "is_expired": false,
        "expires_at": 0,
        "remark": "spot market maker"

    },
    "message": "OK"
}