GEThttps://api.veriko.mx/v1/usage/limits

User-visible rate limits

Audience
public
Auth
API key
Permission
usage:read_self
How-to guide →

Returns the rate limits that apply to the authenticated user, by context.

The contexts do not carry the same limits. api limits authenticated requests per key and per minute, with the value of the account plan (key_per_minute), and adds a per-IP ceiling (ip_ceiling_per_minute); requests without a key are limited per IP (ip_per_minute). webhooks sets the deliveries per minute the account may send to a single destination host, per its plan (host_per_minute), and the cap for all customers together on that host (host_global_per_minute). login limits per IP and per email, each one per minute and per hour.

It does not return live counters, only the current configuration. These limits are unrelated to the monthly validation quota, which is returned by GET /v1/usage/summary. The consumption of the current window is reported, on every authenticated API response, by the X-RateLimit-* headers.

Request
curl -X GET 'https://api.veriko.mx/v1/usage/limits' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200GetUsageLimitsAttributes — Static rate limit configuration by context.
FieldTypeDescription
dataobject

Response body, in the JSON:API envelope.

typestring

JSON:API resource type. Always usage_limits.

e.g. usage_limits
attributesobject

Limits data: the per-context limits and their notes.

rate_limitsobject

Rate limits by context. Each entry carries only the ones that context applies: api carries key_per_minute, ip_ceiling_per_minute and ip_per_minute; webhooks, host_per_minute and host_global_per_minute; login, the four IP and email ones. key_per_minute and host_per_minute are set by the account plan.

notesarray

Human-readable notes about the limits, resolved to the request locale.

Response status codesGET /v1/usage/limits
StatusClassDescriptionBody
2002xxStatic rate limit configuration by context.GetUsageLimitsAttributes
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Errors from GET /v1/usage/limits
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d