Page Comparison

...

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

...

Expand

title	General high-level API calls (api)

Status
colour Blue
title GET
/api/folder/{folderId}/tree/ Return a tree containing all children of the specified folder
Status
colour Blue
title GET
/api/request/{requestId}/ Return the contents of the specified request
Status
colour Blue
title GET
/api/status/ Report the status of the API backend, including mode
Status
colour Blue
title GET
/api/tree/ Return the highest level tree for this install
Status
colour Blue
title GET
/api/{entity}/allconfig/ Return a full listing of an entity type (nodes, apps, objects)
Status
colour Blue
title GET
/api/{entity}/allconfigfromtypes/ Return a full listing of an entity type (nodes, apps, objects)
Status
colour Blue
title GET
/api/{schemaId}/schema/ Return the schema file for the specified schema ID
Status
colour Blue
title GET
/api/itemTypes Return list of schema item types
Status
colour Blue
title GET
/api/schema/ Return the schema files for the specified schema IDs
Status
colour Green
title POST
/api/{category}/{itemId}/move/ Move node or folder to new location
Status
colour Green
title POST
/api/folder/add/ Add new folder
Status
colour Blue
title GET
/api/folder/{folderId}/view/ Get folder properties
Status
colour Green
title POST
/api/folder/{folderId}/delete/Delete folder
Status
colour Blue
title GET
/api/folder/{folderId}/config/ Get folder configurations
Status
colour Green
title POST
/api/folder/{folderId}/config/Adjust the settings of the specified node

Expand

title	Operations on a specified node (api_node)

Status
colour Blue
title GET
/api/{nodeId}/apps/ Return a list of all apps under the specified node
Status
colour Green
title POST
/api/{nodeId}/command/ Send a command to the specified node
Status
colour Blue
title GET
/api/{nodeId}/config/ Return the settings for the specified node
Status
colour Green
title POST
/api/{nodeId}/config/ Adjust the settings for the specified node
Status
colour Green
title POST
/api/{nodeId}/delete/ Delete the specified node from the remote manager database
Status
colour Blue
title GET
/api/{nodeId}/export/ Full recursive export for the specified node
Status
colour Green
title POST
/api/{nodeId}/import/ Full recursive import for the specified node
Status
colour Green
title POST
/api/{nodeId}/sync/ Sync the specified node to the remote manager
Status
colour Blue
title GET
/api/{nodeId}/tree/ Return the highest level tree for the specified node
Status
colour Blue
title GET
/api/{nodeId}/view/ Return the schema and settings for the specified node
Status
colour Blue
title GET
/api/{nodeId}/defaults/ Return node defaults configurations

Expand

title	Operations on a specified app (api_app)

Status
colour Green
title POST
/api/{nodeId}/{appId}/command/ Send a command to the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/config/ Return the settings for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/config/ Adjust the settings for the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/export/ Full recursive export for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/import/ Full recursive import for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/license/ Set the license for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/licenserequest/ Request a license for the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/models/ List all models that can be added in the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/tree/ Return the highest level tree for the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/view/ Return the schema and settings for the specified app
Status
colour Blue
title GET
/api/{appId}/{schemaId}/get_metadata/ Return metadata properties associated with the schema for the specified app
Status
colour Blue
title GET
/api/{appId}/{schemaId}/metadata_schema/ Return schema injected with the properties for the specified app

Expand

title	Operations on a specified object (api_object)

Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/children/ List the direct children of the specified object
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/command/ Send a command to the specified object
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/config/ Return the settings for the specified object
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/config/ Adjust the settings for the specified object
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/copy/ Create a recursive copy of the specified object
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/delete/ Delete the specified object
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/export/ Full recursive export for the specified object
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/import/ Full recursive import for the specified object
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/tree/ Return the highest level tree for the specified object
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/view/ Return the schema and settings for the specified object
Status
colour Blue
title GET
/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)

Status
colour Green
title POST
/log/delete/{applabel}/ Delete all logs under the specified app label
Status
colour Green
title POST
/log/delete/{applabel}/{filename}/ Delete the specified log file
Status
colour Blue
title GET
/log/download/{applabel}/{filename}/ Return the contents of the specified log file
Status
colour Blue
title GET
/log/getlogs/ List all available logs
Status
colour Blue
title GET
/log/zip/ Create a zip file containing all logs
Status
colour Blue
title GET
/log/gettextlogs/Get list of all logs
Status
colour Blue
title GET
/log/query/{applabel}/{filename}/{count}/ Return the contents of the specified log file

Expand

title	General system information (system)

Status
colour Blue
title GET
/system/systemDateTime/ Return the current date and time for the system (in Unix Epoch time)
Status
colour Blue
title GET
/system/systemInfo/ Return information about the system

Expand

title	Operations involving package management (packagemanager)

Status
colour Blue
title GET
/packagemanager/info/{installId}/ Return installed package details
Status
colour Blue
title GET
/packagemanager/tree/ Return list of installed packages
Status
colour Blue
title GET
/packagemanager/available/ Return list of packages that can be installed
Status
colour Blue
title GET
/packagemanager/history/Return list of packages that were installed
Status
colour Green
title POST
/packagemanager/uploadModule/ Upload package for installation
Status
colour Green
title POST
/packagemanager/{nodeId}/delete/{packageId}/ Delete imported package
Status
colour Green
title POST
/packagemanager/{nodeId}/install/ Install package
Status
colour Green
title POST
/packagemanager/{nodeId}/uninstall/Uninstall package
Status
colour Green
title POST
/packagemanager/{nodeId}/remoteUpload/Remote upload packages

Expand

title	Dashboard operations (dashboard)

Status
colour Blue
title GET
/dashboard/ Return list of nodes

Expand

title	Operations involving mqtt (mqtt)

Status
colour Blue
title GET
/mqtt/{nodeId}/{action}/ Get node information
Status
colour Green
title POST
/mqtt/{nodeId}/{action}/ Perform action on node

Versions Compared

Old Version 8

New Version Current

Key

Installing Swagger Editor locally