REST API
Authentication, scopes, endpoints and rate limits.
AUTHENTICATION
Create an API key in your account settings and send it as a Bearer token. Keys are hashed on the server and shown exactly once.
SCOPES
Every key carries explicit scopes. A request without the matching scope is rejected with 403.
- -bots:read โ list bots and read their status
- -bots:control โ start, stop and restart processes
- -bots:logs โ read process logs
ENDPOINTS
All responses are JSON and contain an ok flag. Only products owned by the key's user are visible.
RATE LIMITS
Requests are limited per key and minute. Every response carries the remaining budget in the X-RateLimit-Remaining header; exceeding it returns 429.
ERRORS
Errors return the HTTP status plus a stable error code and a human readable message, for example UNAUTHENTICATED, SCOPE, RATE_LIMIT or PRODUCT_NOT_FOUND.
ENDPOINTS
curl -H "Authorization: Bearer $API_KEY" \
https://aerobots.eu/api/v1/bots
| TYPE | PATH | SCOPES |
|---|---|---|
| GET | /api/v1/bots | bots:read |
| GET | /api/v1/bots/{id} | bots:read |
| POST | /api/v1/bots/{id}/start | bots:control |
| POST | /api/v1/bots/{id}/stop | bots:control |
| POST | /api/v1/bots/{id}/restart | bots:control |
| GET | /api/v1/bots/{id}/logs?lines=50 | bots:logs |
60 req/min ยท X-RateLimit-Remaining