HTTP API
EMQX Neuron provides REST APIs for management and monitoring, following the OpenAPI (Swagger) 3.1 specification and covering system administration, collection configuration, and runtime statistics.
Once the service is running, open http://<gateway address>:8085/api-docs/index.html for the full interface documentation, where requests can also be issued directly from the Swagger UI. An online copy is available as the API reference.
| Page | Contents |
|---|---|
| JWT Authentication | The API uses JWT authentication; this page covers obtaining and using a token |
| Driver and Application Settings | The parameter structure for configuring each southbound driver and northbound application through the API |
| Data Types | How tag data types are represented in the API |
| Error Codes | Every error code and its meaning, for diagnosing failed calls |
TIP
For a worked example of controlling a device through the API, see Data Monitoring and Device Control.