API Reference

The kAudit Public REST API lets you query your audit data programmatically. Use it to build custom dashboards, integrate with SIEMs, or automate monitoring workflows.

Base URL

https://api.kovoco.net/api/v1/public

Authentication

All API requests require an API key. Include it in the X-Api-Key request header:

GET /api/v1/public/audit-activity
X-Api-Key: your-api-key-here

To create an API key, see API Keys.

Content type

All requests and responses use application/json. Include Content-Type: application/json on requests with a body.

Response format

Paginated list endpoints return a standard envelope:

{
  "data": [ ... ],
  "meta": {
    "totalCount": 142,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "timestamp": "2026-05-03T12:00:00Z",
    "apiVersion": "1.0"
  }
}

Single-item endpoints return:

{
  "data": { ... },
  "meta": {
    "timestamp": "2026-05-03T12:00:00Z",
    "apiVersion": "1.0"
  }
}

Use the page and pageSize query parameters to paginate through results (default pageSize is 20, maximum is 100).

Error responses

HTTP Status	Meaning
400	Bad request — invalid parameters
401	Unauthorized — missing or invalid API key
403	Forbidden — API key does not have the required scope
404	Resource not found
429	Rate limit exceeded — slow down your request rate
503	Service unavailable — the query service is temporarily offline

Error responses include a JSON body:

{
  "error": {
    "code": "invalid_parameter",
    "message": "pageSize must be between 1 and 100"
  }
}

Rate limiting

Public API keys are rate-limited per sliding minute window:

Request type	Default limit
GET (read)	60 requests / minute

Exceeding the limit returns 429 Too Many Requests with a Retry-After header indicating when you can retry.

Available endpoints

Endpoint	Scope required	Description
GET /audit-activity	read:audit-activity	List audit activity events
GET /audit-activity/{recordId}	read:audit-activity	Get a single audit activity event
GET /audit-activity/summary	read:audit-activity	Get audit activity summary metrics

Coming soon

Additional endpoints for findings, alerts, and reports are planned for a future release.

OpenAPI specification

The full OpenAPI specification is available at:

https://api.kovoco.net/swagger

Use this to generate client libraries with tools such as openapi-generator or the NSwag Studio.