API Client
Generate and manage API keys to connect your third-party applications securely to our system. Base route: /api/v1/ApiClient
Endpoints
| Method | Route | Permission | Description |
|---|---|---|---|
| POST | /api/v1/ApiClient | ApiClient:Create | Generate a brand new API key |
| GET | /api/v1/ApiClient | ApiClient:View | View a list of all your active API keys |
| GET | /api/v1/ApiClient/{id} | ApiClient:View | Check the details of a specific API key |
| PUT | /api/v1/ApiClient/{id} | ApiClient:Edit | Update the name or settings of an existing API key |
| POST | /api/v1/ApiClient/{id}/revoke | ApiClient:Revoke | Instantly disable an API key if it's compromised |
| POST | /api/v1/ApiClient/{id}/regenerate | ApiClient:Regenerate | Generate a new secret for an existing API key |
| GET | /api/v1/ApiClient/{id}/usage | ApiClient:View | See exactly how often an API key is being used |
POST
/api/v1/ApiClient
JSON Request
{
"name": "CRM Integration",
"description": "API key for our Salesforce integration",
"allowedIps": ["203.0.113.0/24"],
"expiresAt": null
}JSON Response
{
"isSuccess": true,
"data": {
"id": "guid",
"name": "CRM Integration",
"apiKey": "tok_live_xxxxxxxxxxxxxxxxxx",
"createdAt": "2026-05-27T10:00:00Z",
"status": "Active"
}
}The full
apiKey value is only returned once on creation or regeneration. Store it securely — it cannot be retrieved again.GET
/api/v1/ApiClient/{id}/usage
Query Parameters
| Parameter | Type | Default |
|---|---|---|
from | DateTime? | UtcNow - 7 days |
to | DateTime? | UtcNow |
pageNumber | int | 1 |
pageSize | int | 20 |