Page Comparison

...

Expand

title	Account management (accounts)

Status
colour Green
title POST
/accounts/api-token-auth/ Generate API token to authorize session
Status
colour Green
title POST
/accounts/changePassword/ Change the password of the specified user
Status
colour Blue
title GET
/accounts/check_user/ Return username of logged in user

Operations on a specified node (api_node)

Expand

title	General high-level API calls (api)

title

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/{schemaIdentity}/schema/ Return the schema file for the specified schema ID

Expand

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/{nodeId}/apps/ Return a list of all apps under the specified nodeitemTypes Return list of schema item types
Status
colour GreenBlue
title POSTGET
/api/api/{nodeId}/command/ Send a command to the specified nodeschema/ Return the schema files for the specified schema IDs
Status
colour BlueGreen
title GETPOST
/api/{category}/{nodeIditemId}/config/ Return the settings for the specified nodemove/ Move node or folder to new location
Status
colour Green
title POST
/api/{nodeId}/config/ Adjust the settings for the specified nodefolder/add/ Add new folder
Status
colour GreenBlue
title POSTGET
/api/folder/{nodeIdfolderId}/delete/ Delete the specified node from the remote manager databaseview/ Get folder properties
Status
colour BlueGreen
title GETPOST
/api/folder/{nodeIdfolderId}/export/ Full recursive export for the specified nodedelete/Delete folder
Status
colour GreenBlue
title POSTGET
/api/folder/{nodeIdfolderId}/import/ Full recursive import for the specified nodeconfig/ Get folder configurations
Status
colour Green
title POST
/api/folder/{nodeIdfolderId}/sync/ Sync the specified node to the remote managerconfig/Adjust the settings of the specified node

Expand

title	Operations on a specified node (api_node)

Status
colour Blue
title GET
/api/{nodeId}/treeapps/ Return the highest level tree for the a list of all apps under the specified node
Status
colour BlueGreen
title GETPOST
/api/{nodeId}/view/ Return the schema and settings for the specified node

Expand

title	Operations on a specified app (api_app)

command/ Send a command to the specified node
Status
colour GreenBlue
title POSTGET
/api/{nodeId}/{appId}/command/ Send a command to the specified appconfig/ Return the settings for the specified node
Status
colour BlueGreen
title GETPOST
/api/{nodeId}/{appId}/config/ Return config/ Adjust the settings for the specified appnode
Status
colour Green
title POST
/api/{nodeId}/{appId}/config/ Adjust the settings for the specified appdelete/ Delete the specified node from the remote manager database
Status
colour Blue
title GET
/api/{nodeId}/{appId}/export/ Full recursive export for the specified appnode
Status
colour Green
title POST
/api/{nodeId}/{appId}/import/ Full recursive import for the specified appnode
Status
colour Green
title POST
/api/{nodeId}/{appId}/license/ Set the license for the specified appsync/ Sync the specified node to the remote manager
Status
colour GreenBlue
title POSTGET
/api/{nodeId}/{appId}/licenserequest/ Request a license tree/ Return the highest level tree for the specified appnode
Status
colour Blue
title GET
/api/{nodeId}/{appId}/models/ List all models that can be added in the specified appview/ Return the schema and settings for the specified node
Status
colour Blue
title GET
/api/{nodeId}/{appId}/tree/ Return the highest level tree for the specified appdefaults/ Return node defaults configurations

Operations on a specified object (api_object)

Expand

title	Operations on a specified app (api_app)

Status
colour BlueGreen
title GETPOST
/api/{nodeId}/{appId}/view/ Return the schema and settings for command/ Send a command to the specified app

Expand

title

Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/children/ List the direct children of the specified objectconfig/ Return the settings for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/command/ Send a command to the specified objectconfig/ Adjust the settings for the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/config/ Return the settings export/ Full recursive export for the specified objectapp
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/config/ Adjust the settings import/ Full recursive import for the specified objectapp
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/copy/ Create a recursive copy of the specified objectlicense/ Set the license for the specified app
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectId}/delete/ Delete licenserequest/ Request a license for the specified objectapp
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/export/ Full recursive export for the specified objectmodels/ List all models that can be added in the specified app
Status
colour GreenBlue
title POSTGET
/api/{nodeId}/{appId}/{objectId}/import/ Full recursive import tree/ Return the highest level tree for the specified objectapp
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectId}/treeview/ Return the highest level tree schema and settings for the specified objectapp
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectIdschemaId}/viewget_metadata/ Return metadata properties associated with the schema and settings for the specified objectapp
Status
colour Blue
title GET
/api/{nodeIdappId}/{appIdschemaId}/{objectId}/{objectType}/children/ List all children of the specified object that are of the specified typemetadata_schema/ Return schema injected with the properties for the specified app

Expand

title	Operations involving on a specified object type within a specified app (api_objectTypeobject)

Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectTypeobjectId}/addchildren/ Return the default schema for List the direct children of the specified object type
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectTypeobjectId}/addcommand/ Create a new instance of Send a command to the specified object type under the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectTypeobjectId}/allconfig/ List all objects of the specified type under the specified app, along with their settingsconfig/ Return the settings for the specified object
Status
colour BlueGreen
title GETPOST
/api/{nodeId}/{appId}/{objectTypeobjectId}/listing/ List all instances of config/ Adjust the settings for the specified object type under the specified app
Status
colour BlueGreen
title GETPOST
/api/{nodeId}/{appId}/{objectTypeobjectId}/newviewcopy/ Return a schema file filled with default values in order to display new items in UI

Expand

title	Log file handling (log)

Create a recursive copy of the specified object
Status
colour Green
title POST
/log/delete/{applabel}/ Delete all logs under the specified app label/api/{nodeId}/{appId}/{objectId}/delete/ Delete the specified object
Status
colour GreenBlue
title POSTGET
/log/deleteapi/{nodeId}/{applabelappId}/{filenameobjectId}/ Delete export/ Full recursive export for the specified log fileobject
Status
colour BlueGreen
title GETPOST
/log/downloadapi/{nodeId}/{applabelappId}/{filenameobjectId}/ Return the contents of /import/ Full recursive import for the specified log fileobject
Status
colour Blue
title GET
/log/getlogs/ List all available logsapi/{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	Operations involving a specified object type within a specified app (api_objectType)

Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectType}/add/ Return the default schema for the specified object type
Status
colour Green
title POST
/api/{nodeId}/{appId}/{objectType}/add/ Create a new instance of the specified object type under the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectType}/allconfig/ List all objects of the specified type under the specified app, along with their settings
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectType}/listing/ List all instances of the specified object type under the specified app
Status
colour Blue
title GET
/api/{nodeId}/{appId}/{objectType}/newview/ Return a schema file filled with default values in order to display new items in UI

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

General system information (system)Operations involving package management (packagemanager)

Expand

title	Operations involving package management (packagemanager)

title

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
/logpackagemanager/zip/ Create a zip file containing all logs

Expand

title

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 BlueGreen
title GETPOST
/systempackagemanager/systemDateTime/ Return the current date and time for the system (in Unix Epoch time)uploadModule/ Upload package for installation
Status
colour BlueGreen
title GETPOST
/system/systemInfo/ Return information about the system

Expand

/packagemanager/{nodeId}/delete/{packageId}/ Delete imported package
Status
colour BlueGreen
title GETPOST
/packagemanagerpackagemanager/info/{installId} Return installed package detailsnodeId}/install/ Install package
Status
colour BlueGreen
title GETPOST
/packagemanager/tree Return list of installed packages /packagemanager/{nodeId}/uninstall/Uninstall package
Status
colour BlueGreen
title GETPOST
/packagemanager/available Return list of packages that can be installed /packagemanager/{nodeId}/remoteUpload/Remote upload packages

Expand

title	Dashboard operations (dashboard)

Status
colour Blue
title GET
/packagemanagerdashboard/history Return list of packages that were installed
Status
colour Green
title POST
/packagemanager/uploadModule Upload package for installationnodes

Expand

title	Operations involving mqtt (mqtt)

Status
colour GreenBlue
title POSTGET
/packagemanagermqtt/{nodeId}/delete/{packageId} Delete imported packageaction}/ Get node information
Status
colour Green
title POST
/packagemanagermqtt/{nodeId}/install Install package
Status
colour Green
title POST
/packagemanager/{nodeIdaction}/uninstallUninstall package Perform action on node

Versions Compared

Old Version 11

New Version 12

Key