API Reference
Interactive API documentation and endpoint reference. Use this guide alongside the Swagger UI for detailed request/response schemas.
This page complements the interactive Swagger UI with conceptual guides and field-level documentation.
Interactive Docs
The Swagger UI provides:
- Try it out — Execute requests against the API
- Request/response schemas — See exact payload shapes
- Authentication — Test with your API key or Bearer token
Use the links below for deeper documentation on each area.
Quick Links
| Topic | Description |
|---|---|
| Getting Started | Base URL, overview, and quick links |
| Authentication | Bearer tokens, API keys, and org scoping |
| Asset Endpoints | Application zones, locations, and devices |
| Data Endpoints | Sensor time-series, irrigation, ET, vegetation indices |
| Device Lifecycle | Activate, assign, and deactivate devices |
| Asset Workflow | Pump stations, application zones, and devices |
Support
Contact your Vital representative for API keys, base URLs, and integration support.