WEGA GPS API Reference
REST API for the WEGA GPS tracking server. Manage devices, read positions and events, run reports, and send commands.
To use the API you need a server instance. For testing you can use one of the free demo servers. For production, install your own server or get a subscription service.
The server and authentication choices update every curl example on this page.
Authentication
Every endpoint requires authentication unless it is marked Public. Two schemes are supported and either one is accepted.
| Scheme | Type | How to use it |
|---|---|---|
| BasicAuth | http, basic | Send your WEGA GPS email and password as HTTP Basic credentials. |
| ApiKey | http, bearer | Send a session token in the Authorization: Bearer header. Create one with POST /session/token and revoke it with POST /session/token/revoke. |
Conventions
Details that apply across the whole API.
| Topic | Behavior |
|---|---|
| Dates and times | ISO 8601, for example 1963-11-22T18:30:00Z. |
| Units | Speed is in knots, distance in meters, fuel in liters, altitude in meters, and course in degrees (0 to 360, 0 is true north). |
| List endpoints | Most list endpoints accept all (admins and managers only), userId, limit, offset and keyword. Without parameters they return the objects the current user can access. |
| Multiple values | Pass repeated parameters, for example id=31&id=42. Report endpoints accept repeated deviceId and groupId; at least one of them is required. |
| Linking objects | Relationships between objects (user to device, device to geofence and so on) are managed with the Permissions endpoints. Order matters in the permission body. |
| Report downloads | Most reports also have a /{type} variant. Use xlsx to download a spreadsheet or mail to receive it by email asynchronously (204). |
| Live positions | Use the WEGA GPS WebSocket API instead of polling GET /positions. |
| MCP | Operations marked MCP carry the x-mcp flag in the OpenAPI document. |
No endpoints match your filter.
Schemas
Objects used in request and response bodies.