...
With Swagger Editor, you can view and edit the OpenAPI document inside your browser, while previewing the documentation in real time.
Visit https://editor-next.swagger.io/ and select File → Import file, or drag-and-drop the openapi.json file into the browser window.
...
| Info |
|---|
Note: This method will allow you to view the documentation in Swagger UI, but you will only be able to interact with the API if it can be accessed from a public URL/IP address. In that case, replace http://localhost:5000/ in the url field with the correct address. Otherwise, you will need to install locally (see below) on the system that is running the Django backend in order to issue API calls through Swagger UI. Starting with Open API version 3.1.0, a new Swagger Editor was release (this is the linked version above) Legacy Open API Swagger Editor which supports versions 3.0.X can be accessed by visiting https://editor.swagger.io/ |
Installing Swagger Editor locally
...
In order to use the API, you will need to provide an authorization token.
When making an API call, use -H 'Authorization: Token 123abc', replacing 123abc with your token.
If you are using Swagger UI, click on the ‘Authorize’ button and use value Token 123abc, replacing 123abc with your token.
You can generate an authentication token from your username and password with a
/accounts/api-token-auth/ call, with the following request body:
...
If you fail to authenticate, any API calls (except for /accounts/api-token-auth/) will return an error code 401.
When making an API call, use -H 'Authorization: Token 123abc', replacing 123abc with your token.
If you are using Swagger UI, click on the ‘Authorize’ button and use value Token 123abc, replacing 123abc with your token.
If you are using something like Postman, click on Headers and add these, replacing 123abc with your token.
...
Error Codes
The API uses conventional HTTP response codes to indicate the success or failure of an API request.
...
| Expand |
|---|
| title | General high-level API calls (api) |
|---|
|
-
/api/folder/{folderId}/tree/ Return a tree containing all children of the specified folder -
/api/request/{requestId}/ Return the contents of the specified request -
/api/status/ Report the status of the API backend, including mode -
/api/tree/ Return the highest level tree for this install -
/api/{entity}/allconfig/ Return a full listing of an entity type (nodes, apps, objects) -
/api/{entity}/allconfigfromtypes/ Return a full listing of an entity type (nodes, apps, objects) -
/api/{schemaId}/schema/ Return the schema file for the specified schema ID -
/api/itemTypes Return list of schema item types -
/api/schema/ Return the schema files for the specified schema IDs -
/api/{category}/{itemId}/move/ Move node or folder to new location -
/api/folder/add/ Add new folder -
/api/folder/{folderId}/view/ Get folder properties -
/api/folder/{folderId}/delete/Delete folder -
/api/folder/{folderId}/config/ Get folder configurations -
/api/folder/{folderId}/config/Adjust the settings of the specified node
|
| Expand |
|---|
| title | Operations on a specified node (api_node) |
|---|
|
-
/api/{nodeId}/apps/ Return a list of all apps under the specified node -
/api/{nodeId}/command/ Send a command to the specified node -
/api/{nodeId}/config/ Return the settings for the specified node -
/api/{nodeId}/config/ Adjust the settings for the specified node -
/api/{nodeId}/delete/ Delete the specified node from the remote manager database -
/api/{nodeId}/export/ Full recursive export for the specified node -
/api/{nodeId}/import/ Full recursive import for the specified node -
/api/{nodeId}/sync/ Sync the specified node to the remote manager -
/api/{nodeId}/tree/ Return the highest level tree for the specified node -
/api/{nodeId}/view/ Return the schema and settings for the specified node -
/api/{nodeId}/defaults/ Return node defaults configurations
|
| Expand |
|---|
| title | Operations on a specified app (api_app) |
|---|
|
-
/api/{nodeId}/{appId}/command/ Send a command to the specified app -
/api/{nodeId}/{appId}/config/ Return the settings for the specified app -
/api/{nodeId}/{appId}/config/ Adjust the settings for the specified app -
/api/{nodeId}/{appId}/export/ Full recursive export for the specified app -
/api/{nodeId}/{appId}/import/ Full recursive import for the specified app -
/api/{nodeId}/{appId}/license/ Set the license for the specified app -
/api/{nodeId}/{appId}/licenserequest/ Request a license for the specified app -
/api/{nodeId}/{appId}/models/ List all models that can be added in the specified app -
/api/{nodeId}/{appId}/tree/ Return the highest level tree for the specified app -
/api/{nodeId}/{appId}/view/ Return the schema and settings for the specified app -
/api/{appId}/{schemaId}/get_metadata/ Return metadata properties associated with the schema for the specified app -
/api/{appId}/{schemaId}/metadata_schema/ Return schema injected with the properties for the specified app
|
| Expand |
|---|
| title | Operations on a specified object (api_object) |
|---|
|
-
/api/{nodeId}/{appId}/{objectId}/children/ List the direct children of the specified object -
/api/{nodeId}/{appId}/{objectId}/command/ Send a command to the specified object -
/api/{nodeId}/{appId}/{objectId}/config/ Return the settings for the specified object -
/api/{nodeId}/{appId}/{objectId}/config/ Adjust the settings for the specified object -
/api/{nodeId}/{appId}/{objectId}/copy/ Create a recursive copy of the specified object -
/api/{nodeId}/{appId}/{objectId}/delete/ Delete the specified object -
/api/{nodeId}/{appId}/{objectId}/export/ Full recursive export for the specified object -
/api/{nodeId}/{appId}/{objectId}/import/ Full recursive import for the specified object -
/api/{nodeId}/{appId}/{objectId}/tree/ Return the highest level tree for the specified object -
/api/{nodeId}/{appId}/{objectId}/view/ Return the schema and settings for the specified object -
/api/{nodeId}/{appId}/{objectId}/{objectType}/children/ List all children of the specified object that are of the specified type
|
...
| Expand |
|---|
| title | Log file handling (log) |
|---|
|
-
/log/delete/{applabel}/ Delete all logs under the specified app label -
/log/delete/{applabel}/{filename}/ Delete the specified log file -
/log/download/{applabel}/{filename}/ Return the contents of the specified log file -
/log/getlogs/ List all available logs -
/log/zip/ Create a zip file containing all logs -
/log/gettextlogs/Get list of all logs -
/log/query/{applabel}/{filename}/{count}/ Return the contents of the specified log file
|
| Expand |
|---|
| title | General system information (system) |
|---|
|
-
/system/systemDateTime/ Return the current date and time for the system (in Unix Epoch time) -
/system/systemInfo/ Return information about the system
|
| Expand |
|---|
| title | Operations involving package management (packagemanager) |
|---|
|
-
/packagemanager/info/{installId}/ Return installed package details -
/packagemanager/tree/ Return list of installed packages -
/packagemanager/available/ Return list of packages that can be installed -
/packagemanager/history/Return list of packages that were installed -
/packagemanager/uploadModule/ Upload package for installation -
/packagemanager/{nodeId}/delete/{packageId}/ Delete imported package -
/packagemanager/{nodeId}/install/ Install package -
/packagemanager/{nodeId}/uninstall/Uninstall package -
/packagemanager/{nodeId}/remoteUpload/Remote upload packages
|
| Expand |
|---|
| title | Dashboard operations (dashboard) |
|---|
|
-
/dashboard/ Return list of nodes
|
| Expand |
|---|
| title | Operations involving mqtt (mqtt) |
|---|
|
-
/mqtt/{nodeId}/{action}/ Get node information -
/mqtt/{nodeId}/{action}/ Perform action on node
|