REST API
Errors and rate limits
Understand Paperpin REST API error codes, validation failures, rate-limit responses, and safe retry behavior.
Errors always use the following JSON shape:
{
"error": {
"code": "validation_error",
"message": "Invalid group data."
}
}| Status | Code | Meaning |
|---|---|---|
400 | validation_error | Invalid request body, query value, cursor, or resource input. |
400 | invalid_monitor | A monitor does not have a valid watch area and cannot run. |
401 | unauthorized | Missing, malformed, revoked, expired, or invalid API key. |
402 | run_limit_reached | A manual run cannot be queued because the tenant run limit is reached. |
404 | not_found | The resource does not exist in the authenticated tenant. |
409 | conflict | A group with the same tenant-scoped name already exists. |
429 | rate_limited | The API key exceeded its request allowance. |
500 | internal_error | PaperPin could not process the request. |
Public API requests are limited per API key. Rate-limit responses include the standard PaperPin rate-limit headers. On 429, wait until the reset time indicated by the response headers before retrying; do not retry non-idempotent requests blindly.