> For the complete documentation index, see [llms.txt](https://docs.net2grid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.net2grid.com/integration-guide/device-management-api.md). # Device Management API The Device Management API retrieves information about NET2GRID's hardware connected to smart meters and provides tools for customers to manage the hardware devices remotely. It is publicly available and protected by an API Key. ## Available Operations Currently, the service supports the following operations: * Ensure that a smart bridge will forget the WiFi credentials and connection. * Configure Real-time Edge Event Reporting thresholds (Capacity Peaks and Power Thresholds) for a labelpartner's fleet. * Configure the Continuous Low-Resolution Energy Stream (metric selection and reporting interval) for a labelpartner's fleet. * Configure Continuous Dynamic Reporting (metric selection, reporting threshold, and time-of-day filter) for a labelpartner's fleet. * Configure Asynchronous High-Resolution Data Export (enable/disable and metric selection) for a labelpartner's fleet. * Configure Real-time Edge Event Reporting thresholds (Capacity Peaks and Power Thresholds) for an individual smart bridge. * Configure Real-time Edge Event Reporting thresholds (Capacity Peaks and Power Thresholds) for a labelpartner's fleet. As the product evolves, more operations will be added. ## Error Codes The Device Management API's OpenAPI specifications contain all the possible errors that can be returned by each call, along with the response body, if applicable. Some exceptions, like 403 and 404, are returned by the API Gateway service of AWS that works as a middleware. In the REST API documentation, the client will find more exceptions thrown by the application, which are distinguished into two major classes: * Business Logic Exceptions (409) and * Server Exceptions (500). The server exceptions are service report errors, which may indicate a bug or temporary outage. It is advisable to try again after some time, and if this doesn’t work, the client can create a ticket through NET2GRID’s support system to investigate this further. On the other hand, the business logic error means there is a conflict or an abnormal request, and the application is denied, completing the client’s request. Usually, the client must evaluate the error in those cases and configure their application's response accordingly. In every case, an error code will be provided so the client can pass this information to the ticket they may have to create on NET2GRID’s side. ## Getting Access NET2GRID will provide access to the service by providing the API Key. The API Key information is sensitive and should be provided through a secure communication channel. The provided API Key gives the client access to every endpoint. Although the API key does not initially set limitations, NET2GRID can set a maximum rate to protect the infrastructure and keep costs low. ## OpenAPI Specification Interfaces The Device Management API is available in the [API Reference section](https://docs.net2grid.com/device-management-api/). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.net2grid.com/integration-guide/device-management-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.