Developers
API Reference
Send device check-ins, file hashes and security alerts to CyberLetics from your own scripts. It is the same API the CyberLetics agent uses.
Quick start
- Sign in and open Settings → API Keys. Give the key a name and click Generate Key. Copy it: it is shown once.
- Send a check-in for one machine:
curl -X POST https://cyberletics.onrender.com/api/ingest/telemetry \
-H "X-API-Key: cl_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"hostname": "finance-laptop-03",
"ipAddress": "192.168.1.24",
"os": "windows",
"osVersion": "11 23H2",
"deviceType": "laptop",
"antivirusInstalled": true,
"firewallEnabled": true
}'
The device shows up on your Devices page straight away. Keep sending check-ins (the agent does it every few minutes); a device that is silent for 24 hours is marked inactive.
Authentication
Send your key in the X-API-Key header on every request. Keys start with cl_. Only the organisation's owners and admins can create, revoke or delete them.
A key can report devices and raise alerts for your whole organisation, so keep it out of source control and revoke it in Settings if it might have leaked. A revoked key gets 401 INVALID_API_KEY at once.
Limits and usage
- Rate limit: by default 100 requests per 15 minutes from one IP address. Past it you get
429. TheRateLimit-*response headers say how many requests remain and when the window resets. - Devices: new devices count toward your plan's limit: Starter 10, Shield 50, Fortress 200, trial 1. Past it,
/ingest/telemetryfor a new device returns403 DEVICE_LIMIT_REACHED. Check-ins from existing devices keep working. - File lookups: VirusTotal lookups share an hourly budget per organisation. When it runs out the response says
"skipped": trueand why. - Usage: every call is counted against its key for the calendar month (UTC). See the counts in Settings → API Keys. There is no monthly cap on calls today.
Errors
Errors return JSON with a stable error.code you can branch on, and a human-readable message:
{
"success": false,
"message": "Validation failed.",
"error": { "code": "VALIDATION_ERROR", "message": "Validation failed.", "details": [ ... ] }
}
VALIDATION_ERROR: a field is missing or invalid; details lists each one.
401MISSING_API_KEY or INVALID_API_KEY.
402The trial has ended or the subscription is suspended or cancelled.
403DEVICE_LIMIT_REACHED: the plan's device limit is used up.
404NOT_FOUND: the device id is not in your organisation.
429Rate limit reached. Wait for the window in RateLimit-Reset.
Endpoints
Base URL: https://cyberletics.onrender.com/api. All bodies are JSON.
Loading the endpoint reference… If it does not load, open the OpenAPI spec directly.
Need an endpoint that is not here?
Tell us what you want to read or send. Fortress plans include report API access.