REST API
ION Guard provides a complete REST API for integration with external systems, automations, and custom application development.
Endpoint Reference
The interactive, auto-generated endpoint documentation is available at:
https://<seu-servidor>/docs/api
The reference is automatically generated from the source code via Scramble, ensuring it is always up to date with the installed version.
Overview
| Aspect | Detail |
|---|---|
| Base URL | /api/v1 |
| Authentication | Bearer Token (Laravel Sanctum) |
| Format | JSON |
| Pagination | Cursor-based (limit parameter, default 20, maximum 100) |
| Rate Limiting | 60 req/min (user), 5 req/min (auth) |
| Token validity | 24 hours (1440 min), configurable via SANCTUM_TOKEN_EXPIRATION |
| Versioning | Via URL prefix (/v1/) |
Available resources
- Tenants — Organization management
- Sites — Site CRUD
- Zones — Zone management within sites
- Alerts — Listing, details, acknowledge, and resolve
- Events — Domain event history
- Users — User and permission management
- Dashboard — Metrics summary by site
- Audit Logs — Change history
- Health Check —
GET /api/v1/health(no authentication required)
Guides
- Authentication — How to obtain and use access tokens
- Pagination — Cursor-based navigation in lists
- Rate Limiting — Request limits per tier
- Errors — Error response format