Scan Limits
See how many scans a tenant can start per day, week and month.
Scan limits cap how many scans a tenant can start in a day, a week and a month. Use the Scan Limits API to see a tenant's limits, how many scans it has used in each window, and when each window resets.
How scan limits work
New tenants start with these limits:
Day
100 scans
Week
No limit
Month
1,000 scans
Tenants created before scan limits were introduced have no limits unless Telmai sets them.
Each window is counted in UTC:
day
One UTC day, starting at 00:00 UTC
week
One ISO week, starting on Monday at 00:00 UTC
month
One calendar month, starting on the 1st at 00:00 UTC
Every scan counts, whether it is started from Telmai, through the API, or by a schedule.
A scan counts against every window that has a limit. When any of them is full, new scans are refused until that window resets.
A data comparison counts as one scan.
Retrying an existing scan job doesn't count again, and a scan that fails before it launches gives its slot back.
Windows without a limit aren't counted.
When a limit is reached
Scans started from Telmai or the API are refused with
429 Too Many Requests. This applies to the Trigger Scan API.Scheduled scans don't run. The scan job is marked as failed with the same message, which you can see with Track Scan Job.
The error says which limit was reached and when new scans are accepted again. Its category is RATE_LIMITED, and retryable is false because the same request fails until the window resets:
The response also includes code, message and errorId fields. Quote the errorId when you contact support.
Get Scan Limits
GET https://{telmai_endpoint}/api/backend/configuration/tenants/{tenant}/scan-limits
Returns the tenant's limit for each window, the number of scans used in the current window, and when it resets. Only tenant administrators can call this endpoint.
Path Parameters
tenant*
string
Tenant identifier
Response Fields
tenant_id
string
Tenant identifier
windows
array
One entry per window, in the order day, week, month
windows[].window
string
day, week or month
windows[].limit
integer or null
Most scans allowed in the window. null means no limit.
windows[].used
integer
Scans counted in the current window
windows[].resets_at
string
When the current window ends and its count starts again (UTC, ISO 8601)
Responses
Unauthorized
Forbidden — the caller isn't an administrator of the tenant.
Not Found — the tenant doesn't exist.
Related Documentation
Last updated