Versions Compared

Old Version 11

changes.mady.by.user Alejandro Vega

Saved on

compared with

New Version Current

changes.mady.by.user Alejandro Vega

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Operations on a specified node (api_node
Expand
titleGeneral high-level API calls (api)

  • Status
    colourBlue
    titleGET
    ​/api​/folder​/{folderId}​/tree​/ Return a tree containing all children of the specified folder

  • Status
    colourBlue
    titleGET
    ​/api​/request​/{requestId}​/ Return the contents of the specified request

  • Status
    colourBlue
    titleGET
    ​/api​/status​/ Report the status of the API backend, including mode

  • Status
    colourBlue
    titleGET
    ​/api​/tree​/ Return the highest level tree for this install

  • Status
    colourBlue
    titleGET
    ​/api​/{entity}​/allconfig​/ Return a full listing of an entity type (nodes, apps, objects)

  • Status
    colourBlue
    titleGET
    ​/api​/{schemaIdentity}​/schema​allconfig​fromtypes/ Return the schema file for the specified schema ID

Expand
title

  • a full listing of an entity type (nodes, apps, objects)

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeIdschemaId}​/apps​schema​/ Return a list of all apps under the schema file for the specified nodeschema ID

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/command​/ Send a command to the specified nodeitemTypes Return list of schema item types

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/config​/ Return the settings api​​/schema​/ Return the schema files for the specified nodeschema IDs

  • Status
    colourGreen
    titlePOST
    ​/api​/{category}/{nodeIditemId}​/config​/ Adjust the settings for the specified nodemove/ Move node or folder to new location

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/delete​/ Delete the specified node from the remote manager databasefolder/add/ Add new folder

  • Status
    colourBlue
    titleGET
    ​/api​/folder/{nodeIdfolderId}​/export​/ Full recursive export for the specified nodeview/ Get folder properties

  • Status
    colourGreen
    titlePOST
    ​/api​/folder/{nodeIdfolderId}​/import​/ Full recursive import for the specified nodedelete/Delete folder

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/folder/{nodeIdfolderId}​/sync​/ Sync the specified node to the remote managerconfig/ Get folder configurations

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/folder/{nodeIdfolderId}​/tree​config/ Return the highest level tree for the specified nodeAdjust the settings of the specified node

expandexpand
Expand
titleOperations on a specified node (api_node)

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/view​apps​/ Return the schema and settings for a list of all apps under the specified node

titleOperations on a specified app (api_app)

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/command​/ Send a command to the specified appnode

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/config​/ Return the settings for the specified appnode

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/config​/ Adjust the settings for the specified appnode

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/export​/ Full recursive export for the specified appdelete​/ Delete the specified node from the remote manager database

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/{appId}​/import​/export​/ Full recursive import export for the specified appnode

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/license​/ Set the license import​/ Full recursive import for the specified appnode

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/licenserequest​/ Request a license for the specified appsync​/ Sync the specified node to the remote manager

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/models​/ List all models that can be added in the specified apptree​/ Return the highest level tree for the specified node

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/tree​view​/ Return the highest level tree schema and settings for the specified appnode

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/view​/ Return the schema and settings for the specified app

  • defaults​/ Return node defaults configurations

Operations involving a specified object type within a specified app (api_objectType)
Expand
titleOperations on a specified object app (api_objectapp)
title

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/{objectId}​/children​/ List the direct children of the specified objectcommand​/ Send a command to the specified app

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/command​/ Send a command to the specified objectconfig​/ Return the settings for the specified app

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/{objectId}​/config​/ Return Adjust the settings for the specified objectapp

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/config​/ Adjust the settings export​/ Full recursive export for the specified objectapp

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/{objectId}​/copy​/ Create a recursive copy of the specified objectimport​/ Full recursive import for the specified app

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/{objectId}​/delete​/ Delete license​/ Set the license for the specified objectapp

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/{objectId}​/export​/ Full recursive export licenserequest​/ Request a license for the specified objectapp

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/import​/ Full recursive import for the specified objectmodels​/ List all models that can be added in the specified app

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/tree​/ Return the highest level tree for the specified objectapp

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/view​/ Return the schema and settings for the specified objectapp

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectIdschemaId}​/{objectType}​/children​/ List all children of the specified object that are of the specified type

Expand

  • get_metadata​/ Return metadata properties associated with the schema for the specified app

  • Status
    colourBlue
    titleGET
    ​​​/api​/{nodeIdappId}​/{appIdschemaId}​/{objectType}​/add​metadata_schema​/ Return schema injected with the default schema properties for the specified app

typeLog file handling (log)
Expand
titleOperations on a specified object
(api_object)
title

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/api​/{nodeId}​/{appId}​/{objectTypeobjectId}​/add​/ Create a new instance children​/ List the direct children of the specified object type under the specified app

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/{objectTypeobjectId}​/allconfig​/ List all objects of the specified type under the specified app, along with their settingscommand​/ Send a command to the specified object

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectTypeobjectId}​/listing​/ List all instances of config​/ Return the settings for the specified object type under the specified app

  • Status
    colourBlueGreen
    titleGETPOST
    ​/api​/{nodeId}​/{appId}​/{objectTypeobjectId}​/newview​/ Return a schema file filled with default values in order to display new items in UI

Expand

  • config​/ Adjust the settings for the specified object

  • Status
    colourGreen
    titlePOST
    ​/log​/delete​api​/{nodeId}​/{appId}​/{applabelobjectId}​/ Delete all logs under the specified app label/copy​/ Create a recursive copy of the specified object

  • Status
    colourGreen
    titlePOST
    ​/log​/delete​api​/{nodeId}​/{applabelappId}​/{filenameobjectId}​/delete​/ Delete the specified log fileobject

  • Status
    colourBlue
    titleGET
    ​/log​/download​api​/{nodeId}​/{applabelappId}​/{filenameobjectId}​/ Return the contents of the specified log fileexport​/ Full recursive export for the specified object

  • Status
    colourBlueGreen
    titleGETPOST
    ​/log​/getlogs​/ List all available logsapi​/{nodeId}​/{appId}​/{objectId}​/import​/ Full recursive import for the specified object

  • Status
    colourBlue
    titleGET
    ​/log​/zip​/ Create a zip file containing all logs

Expand
titleGeneral system information (system)

  • Status
    colourBlue
    titleGET
    ​/system​/systemDateTime​/ Return the current date and time for the system (in Unix Epoch time)

  • Status
    colourBlue
    titleGET
    ​/system​/systemInfo​/ Return information about the system

Expand
titleOperations involving package management (packagemanager)

  • Status
    colourBlue
    titleGET
    /packagemanager​/info/{installId} Return installed package details

  • Status
    colourBlue
    titleGET
    /packagemanager​/tree Return list of installed packages

  • Status
    colourBlue
    titleGET
    /packagemanager​/available Return list of packages that can be installedapi​/{nodeId}​/{appId}​/{objectId}​/tree​/ Return the highest level tree for the specified object

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/view​/ Return the schema and settings for the specified object

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectId}​/{objectType}​/children​/ List all children of the specified object that are of the specified type

Expand
titleOperations involving a specified object type within a specified app (api_objectType)

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectType}​/add​/ Return the default schema for the specified object type

  • Status
    colourGreen
    titlePOST
    ​/api​/{nodeId}​/{appId}​/{objectType}​/add​/ Create a new instance of the specified object type under the specified app

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectType}​/allconfig​/ List all objects of the specified type under the specified app, along with their settings

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectType}​/listing​/ List all instances of the specified object type under the specified app

  • Status
    colourBlue
    titleGET
    ​/api​/{nodeId}​/{appId}​/{objectType}​/newview​/ Return a schema file filled with default values in order to display new items in UI

Expand
titleLog file handling (log)

  • Status
    colourGreen
    titlePOST
    ​/log​/delete​/{applabel}​/ Delete all logs under the specified app label

  • Status
    colourGreen
    titlePOST
    ​/log​/delete​/{applabel}​/{filename}​/ Delete the specified log file

  • Status
    colourBlue
    titleGET
    ​/log​/download​/{applabel}​/{filename}​/ Return the contents of the specified log file

  • Status
    colourBlue
    titleGET
    ​/log​/getlogs​/ List all available logs

  • Status
    colourBlue
    titleGET
    ​/log​/zip​/ Create a zip file containing all logs

  • Status
    colourBlue
    titleGET
    ​/log​/gettextlogs​/Get list of all logs

  • Status
    colourBlue
    titleGET
    ​/log​/query​/{applabel}/{filename}/{count}/ Return the contents of the specified log file

Expand
titleGeneral system information (system)

  • Status
    colourBlue
    titleGET
    ​/system​/systemDateTime​/ Return the current date and time for the system (in Unix Epoch time)

  • Status
    colourBlue
    titleGET
    ​/system​/systemInfo​/ Return information about the system

Expand
titleOperations involving package management (packagemanager)

  • Status
    colourBlue
    titleGET
    /packagemanager​/info/{installId}/ Return installed package details

  • Status
    colourBlue
    titleGET
    /packagemanager​/tree/ Return list of installed packages

  • Status
    colourBlue
    titleGET
    /packagemanager​/available/ Return list of packages that can be installed

  • Status
    colourBlue
    titleGET
    /packagemanager​/history/Return list of packages that were installed

  • Status
    colourGreen
    titlePOST
    ​/packagemanager/uploadModule/ Upload package for installation

  • Status
    colourGreen
    titlePOST
    ​/packagemanager/{nodeId}/delete/{packageId}/ Delete imported package

  • Status
    colourGreen
    titlePOST
    ​/packagemanager/{nodeId}/install/ Install package

  • Status
    colourGreen
    titlePOST
    ​/packagemanager/{nodeId}/uninstall/Uninstall package

  • Status
    colourGreen
    titlePOST
    ​/packagemanager/{nodeId}/remoteUpload/Remote upload packages

Expand
titleDashboard operations (dashboard)

  • Status
    colourBlue
    titleGET
    /packagemanager​dashboard/history Return list of packages that were installed
    Status
    colourGreen
    titlePOST
    ​/packagemanager/uploadModule Upload package for installationnodes

Expand
titleOperations involving mqtt (mqtt)

  • Status
    colourGreenBlue
    titlePOSTGET
    ​/packagemanagermqtt/{nodeId}/delete/{packageId} Delete imported packageaction}/ Get node information

  • Status
    colourGreen
    titlePOST
    ​/packagemanagermqtt/{nodeId}/install Install package
    Status
    colourGreen
    titlePOST
    ​/packagemanager/{nodeIdaction}/uninstallUninstall package Perform action on node