User — API Key¶
API Keys are alternative authentication tokens for machine-to-machine API usage.
Endpoints¶
| Method | URL |
|---|---|
GET |
/user/<user>/api_key/<api_key> |
POST |
/user/<user>/api_key |
PUT |
/user/<user>/api_key/<api_key> |
DELETE |
/user/<user>/api_key/<api_key> |
GET /user/<user>/api_key/<api_key>¶
Payload: No payload.
Returns: The API key.
POST /user/<user>/api_key¶
| Parameter | Type | Description |
|---|---|---|
name |
string | Key name |
allowed_ips |
string | Comma or space-separated CIDR IP ranges allowed to use this key. Empty = any IP. |
Returns: The new API key.
PUT /user/<user>/api_key/<api_key>¶
Same payload as POST.
Returns: The edited API key.
DELETE /user/<user>/api_key/<api_key>¶
Payload: No payload.
Returns: The deleted API key.