UI Access¶
Backup and Restore¶
/backup-and-restore
Resource |
Context |
Operation |
|
|
|
|
|
|
Resources¶
/resources
Allows loading of all services through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the managing of all resources through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of service links through HTTP and going to the service’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows loading of all servers through HTTP
Resource |
Context |
Operation |
|
|
|
Allows listing of all servers through HTTP and going to the service details page
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the managing of all servers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the loading of all containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Allows the listing of all volumes through HTTP
Resource |
Context |
Operation |
|
|
|
Allows the listing of all volumes through HTTP and going to the volume’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the loading of all connections through HTTP
Resource |
Context |
Operation |
|
|
|
Allows the listing of all connections through HTTP and going to the connection’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the managing of all connections through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the listing of all endpoints through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the listing of all endpoints through HTTP and going to the endpoint’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all endpoints through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the loading of mappings through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the listing of all mappings through HTTP and going to the mapping’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all mappings through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Connections¶
/resources/connections
Allows the listing of all connections through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of all connections through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all connections through HTTP and going to the connection’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the managing of all connections through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Connection¶
/connections/:id
Allows the loading of a single connection through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of a single connection through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the managing of a single connection through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Containers¶
/resources/containers
Allows the loading of all containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Alternatively: Allows the managing of all containers through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the loading of all containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Container¶
/containers/:id
Allows the loading of a single container through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of a single container through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the managing of a single container through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Endpoints¶
/resources/endpoints
Allows the listing of all endpoints through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the managing of all endpoints through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all endpoints through HTTP and going to the endpoint’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all endpoints through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Endpoint¶
/endpoints/:id
Allows the loading of a single endpoint through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the loading of a single endpoint through MQTT and managing of the loaded endpoint
Resource |
Context |
Operation |
|
|
|
Allows the loading of a single endpoint through HTTP and managing of the loaded endpoint
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Mappings¶
/resources/mappings
Allows the listing of all mappings through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the managing of all mappings through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all mappings through HTTP and going to the mapping’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all mappings through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Mapping¶
/mappings/:id
Allows the loading of a single mapping through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the loading of a single mapping through MQTT and managing of the loaded mapping
Resource |
Context |
Operation |
|
|
|
Allows the loading of a single mapping through HTTP and managing of the loaded mapping
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the loading of a single mapping through HTTP
Resource |
Context |
Operation |
Any |
|
|
|
|
|
|
|
|
Servers¶
/resources/servers
Allows the listing of all servers through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of all servers through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all servers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the managing of all servers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Server¶
/servers/:id
Allows the loading of a single server through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the loading of a single server through MQTT and managing of the loaded server
Resource |
Context |
Operation |
|
|
|
Allows the loading of a single server through HTTP and managing of the loaded server
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the loading of a single server through HTTP and list its nodes
Resource |
Context |
Operation |
|
|
|
|
|
|
Service Links¶
/resources/services-links
Allows the listing of service links through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the listing of service links through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of service links through HTTP and going to the service’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Volumes¶
/resources/volumes
Allows the listing of all volumes through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of all volumes through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all volumes through HTTP and going to the volume’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
Volume¶
/volumes/:id
Allows the loading of a single volume through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the loading of a single volume through MQTT
Resource |
Context |
Operation |
|
|
|
Service Catalog¶
/catalog
Allows the use of service catalog through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Services¶
/services
Allows the listing of all services through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the listing and managing of all services through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the listing of all services through HTTP and going to the service’s details page
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the managing of all services through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the listing, creation and update of all services through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the listing and managing of all services through MQTT, with creation and update done through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Service¶
/services/:id
Allows the loading of a single service through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Alternatively: Allows the loading and managing of the loaded service through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the loading of a single service through HTTP and managing of the loaded service
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the loading and update of a single service through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Alternatively: Allows the loading and managing of the loaded service through MQTT, with update done through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related connections
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related containers
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related endpoints
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related mappings
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related servers
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the loading of a single service through HTTP and viewing its related volumes
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
System¶
Agents¶
/agents
Allows the loading of agents through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the loading of agents through MQTT and managing of the loaded agents
Resource |
Context |
Operation |
|
|
|
Info¶
/info
Allows the loading of license and connectivity information
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the loading of services through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Alternatively: Allows the loading of services through MQTT
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Allows the user to update the license
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Metrics¶
/metrics
Allows the user to see the usage metrics
Resource |
Context |
Operation |
|
|
|
|
|
|
Allows the user send metrics to the portal
Resource |
Context |
Operation |
|
|
|
|
|
|
Status¶
/status
Allows the loading of all core containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
Alternatively: Allows the managing of all the core containers through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the loading of all core containers through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
Status¶
/status/:id
Allows the loading of a single core container through HTTP
Resource |
Context |
Operation |
|
|
|
Alternatively: Allows the managing of a single core container through MQTT
Resource |
Context |
Operation |
|
|
|
Allows the managing of a single core container through HTTP
Resource |
Context |
Operation |
|
|
|
|
|
|
Tools¶
Data Explorer¶
/explorer
Allows the loading of the Explorer metadata through HTTP
Resource |
Context |
Operation |
Any |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Alternatively: Allows the loading of the Explorer metadata through MQTT
Resource |
Context |
Operation |
|
|
|
|
|
|
Rule Sandbox¶
/rule-engine-sandbox
Resource |
Context |
Operation |
Any |
|
|
|
|
|
|
|
|
|
|
|
User Management¶
Certificates¶
/certificates
Resource |
Context |
Operation |
|
|
|
|
|
|
Client Registry¶
/client-registry
Resource |
Context |
Operation |
|
|
|
|
|
|
Users and Roles¶
/user-and-roles
Resource |
Context |
Operation |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Workbench¶
Resource |
Context |
Operation |
|
|
|
|
|
|