API Key Management

API Key management endpoints only accept JWT authentication.

Create API Key

1 POST /v1/private/user/api-key/create
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 Content-Type: application/json

Request parameters:

Parameter	Type	Required	Description
`label`	string	Yes	API Key label, length 1 - 64
`permissions`	int	No	Permission bitmask, default `1`, range `1` - `7`
`ipWhitelist`	string[]	No	IP whitelist, up to 20 entries. If omitted, source IP is unrestricted

Request example:

$ curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
>   -H "Content-Type: application/json" \
>   -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>   -d '{
>     "label": "external-service-prod",
>     "permissions": 3,
>     "ipWhitelist": ["203.0.113.10"]
>   }'

Response example:

1 {
2   "code": 0,
3   "message": "success",
4   "data": {
5     "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6     "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7   },
8   "requestId": "req-api-key"
9 }

apiSecret is returned only once when the API Key is created. Store it immediately in a secret management system. Do not write it into source code repositories or logs.

Each user can create up to 30 API Keys.

List API Keys

1 GET /v1/private/user/api-key/list
2 Authorization: Bearer YOUR_ACCESS_TOKEN

Response fields:

Field	Type	Description
`list[].id`	string	API Key ID
`list[].label`	string	Label
`list[].apiKey`	string	Public API Key identifier
`list[].permissions`	int	Permission bitmask
`list[].ipWhitelist`	string[]	IP whitelist
`list[].status`	int	Status: `1` enabled, `0` disabled
`list[].lastUsedAt`	int64	Last used time
`list[].createdAt`	int64	Creation time

Update API Key

1 PUT /v1/private/user/api-key/update
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 Content-Type: application/json

Request parameters:

Parameter	Type	Required	Description
`id`	string	Yes	API Key ID
`label`	string	No	New label
`permissions`	int	No	New permission bitmask
`ipWhitelist`	string[]	No	New IP whitelist
`status`	int	No	`1` enabled, `0` disabled

Delete API Key

1 POST /v1/private/user/api-key/delete
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 Content-Type: application/json

Request body:

1 { "id": "1001" }

Delete All API Keys

1 POST /v1/private/user/api-key/delete-all
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 Content-Type: application/json

Response fields:

Field	Type	Description
`deleted`	int64	Number of deleted API Keys