developer
API reference
This is the stable public contract. Runtime routes not emitted here are not public API.
Authentication
Use an API key with Authorization: Bearer <your API key> on every request. Every returned monitor is limited to the API key's tenant.
List tenant monitors.
- type (optional)
MonitorType- Filter by monitor type. Values: pulse or probe. Omitted returns both types.- state (optional)
MonitorState- Filter by lifecycle state. Values: active, paused, or archived. Omitted returns all states.- limit (optional)
integer- Maximum monitors in one page. Integer from 1 through 200; defaults to 100.- cursor (optional)
string- Opaque next_cursor value to continue keyset pagination. Omitted starts at the first page.- include_observations (optional)
boolean- Include up to 100 recent observations per returned monitor inside plan-visible history. Omitted by default because observations increase response size; defaults to false.
curl https://api.niceuptime.com/v1/monitors \
-H "Authorization: Bearer nu_live_your_token"Responses and rate limits
Response bodies, errors, and rate-limit headers below are generated from the selected public OpenAPI contract.
200 Monitors visible to the tenant.
Body: { monitors: Monitor[], next_cursor?: string }
- RateLimit-Limit
- Maximum requests allowed in the current minute window for this API key's tenant.
integer - RateLimit-Remaining
- Requests remaining in the current minute window for this API key's tenant.
integer - RateLimit-Reset
- Seconds until the applicable rate-limit window resets.
integer - X-RateLimit-Limit
- Legacy alias of RateLimit-Limit.
integer - X-RateLimit-Remaining
- Legacy alias of RateLimit-Remaining.
integer - X-RateLimit-Reset
- Legacy alias of RateLimit-Reset.
integer
400 Invalid input.
Body: Error
401 Missing, expired, or invalid credentials.
Body: Error
429 API-key management rate limit exceeded.
Body: Error
- RateLimit-Limit
- Maximum requests allowed in the current minute window for this API key's tenant.
integer - RateLimit-Remaining
- Requests remaining in the current minute window for this API key's tenant.
integer - RateLimit-Reset
- Seconds until the applicable rate-limit window resets.
integer - X-RateLimit-Limit
- Legacy alias of RateLimit-Limit.
integer - X-RateLimit-Remaining
- Legacy alias of RateLimit-Remaining.
integer - X-RateLimit-Reset
- Legacy alias of RateLimit-Reset.
integer - Retry-After
- Seconds to wait before retrying after a rejected request.
integer
Compatibility
v1 uses SemVer 1.1.2. Compatible additions release as minor versions and compatible corrections as patch versions. Breaking changes require a new URI major and a separately approved public contract.
Enums are closed unless a field is explicitly documented as extensible. See the versioning policy for lifecycle and deprecation rules.