UI Access¶

Backup and Restore¶

/backup-and-restore

Resource	Context	Operation
`/api/maintenance/db/+`	`http`	`readWrite`
`/api/maintenance/db`	`http`	`read`

Resources¶

/resources

Allows loading of all services through HTTP

Resource	Context	Operation
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Alternatively: Allows the managing of all resources through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of service links through HTTP and going to the service’s details page

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Allows loading of all servers through HTTP

Resource	Context	Operation
`/api/servers`	`http`	`read`

Allows listing of all servers through HTTP and going to the service details page

Resource	Context	Operation
`/api/servers/+`	`http`	`read`
`/api/servers`	`http`	`read`

Allows the managing of all servers through HTTP

Resource	Context	Operation
`/api/servers/+/operation`	`http`	`write`
`/api/servers`	`http`	`read`

Allows the loading of all containers through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/orchestrator`	`http`	`read`
`/api/containers`	`http`	`read`

Allows the managing of all containers through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/+/operation`	`http`	`write`
`/api/containers/orchestrator`	`http`	`read`
`/api/containers`	`http`	`read`

Allows the listing of all volumes through HTTP

Resource	Context	Operation
`/api/volumes`	`http`	`read`

Allows the listing of all volumes through HTTP and going to the volume’s details page

Resource	Context	Operation
`/api/volumes/+/inspect`	`http`	`read`
`/api/volumes`	`http`	`read`

Allows the loading of all connections through HTTP

Resource	Context	Operation
`/api/connections`	`http`	`read`

Allows the listing of all connections through HTTP and going to the connection’s details page

Resource	Context	Operation
`/api/connections/+`	`http`	`read`
`/api/connections`	`http`	`read`

Allows the managing of all connections through HTTP

Resource	Context	Operation
`/api/connections/+/operation`	`http`	`write`
`/api/connections`	`http`	`read`

Allows the listing of all endpoints through HTTP

Resource	Context	Operation
`/api/endpoints/+`	`http`	`read`
`/api/endpoints`	`http`	`read`

Allows the listing of all endpoints through HTTP and going to the endpoint’s details page

Resource	Context	Operation
`/api/endpoints/+/topics`	`http`	`read`
`/api/endpoints/+`	`http`	`read`
`/api/endpoints`	`http`	`read`

Allows the managing of all endpoints through HTTP

Resource	Context	Operation
`/api/endpoints/+/operation`	`http`	`write`
`/api/endpoints/+`	`http`	`readWrite`
`/api/endpoints`	`http`	`read`

Allows the loading of mappings through HTTP

Resource	Context	Operation
`/api/mappings/+`	`http`	`read`
`/api/mappings`	`http`	`read`

Allows the listing of all mappings through HTTP and going to the mapping’s details page

Resource	Context	Operation
`/api/mappings/+/endpoint-topics`	`http`	`read`
`/api/mappings/+`	`http`	`read`
`/api/mappings`	`http`	`read`

Allows the managing of all mappings through HTTP

Resource	Context	Operation
`/api/mappings/+/operation`	`http`	`write`
`/api/mappings/+`	`http`	`readWrite`
`/api/mappings`	`http`	`read`

Connections¶

/resources/connections

Allows the listing of all connections through HTTP

Resource	Context	Operation
`/api/connections`	`http`	`read`

Alternatively: Allows the managing of all connections through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all connections through HTTP and going to the connection’s details page

Resource	Context	Operation
`/api/connections/+`	`http`	`read`
`/api/connections`	`http`	`read`

Allows the managing of all connections through HTTP

Resource	Context	Operation
`/api/connections/+/operation`	`http`	`write`
`/api/connections`	`http`	`read`

Connection¶

/connections/:id

Allows the loading of a single connection through HTTP

Resource	Context	Operation
`/api/connections/+`	`http`	`read`

Alternatively: Allows the managing of a single connection through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the managing of a single connection through HTTP

Resource	Context	Operation
`/api/connections/+/operation`	`http`	`write`
`/api/connections/+`	`http`	`read`

Containers¶

/resources/containers

Allows the loading of all containers through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/orchestrator`	`http`	`read`
`/api/containers`	`http`	`read`

Alternatively: Allows the managing of all containers through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of all containers through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/+/operation`	`http`	`write`
`/api/containers/orchestrator`	`http`	`read`
`/api/containers`	`http`	`read`

Container¶

/containers/:id

Allows the loading of a single container through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`

Alternatively: Allows the managing of a single container through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the managing of a single container through HTTP

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/+/operation`	`http`	`write`

Endpoints¶

/resources/endpoints

Allows the listing of all endpoints through HTTP

Resource	Context	Operation
`/api/endpoints/+`	`http`	`read`
`/api/endpoints`	`http`	`read`

Alternatively: Allows the managing of all endpoints through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all endpoints through HTTP and going to the endpoint’s details page

Resource	Context	Operation
`/api/endpoints/+/topics`	`http`	`read`
`/api/endpoints/+`	`http`	`read`
`/api/endpoints`	`http`	`read`

Allows the managing of all endpoints through HTTP

Resource	Context	Operation
`/api/endpoints/+/operation`	`http`	`write`
`/api/endpoints/+`	`http`	`readWrite`
`/api/endpoints`	`http`	`read`

Endpoint¶

/endpoints/:id

Allows the loading of a single endpoint through HTTP

Resource	Context	Operation
`/api/endpoints/+/topics`	`http`	`read`
`/api/endpoints/+`	`http`	`read`

Alternatively: Allows the loading of a single endpoint through MQTT and managing of the loaded endpoint

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of a single endpoint through HTTP and managing of the loaded endpoint

Resource	Context	Operation
`/api/endpoints/+/operation`	`http`	`write`
`/api/endpoints/+/topics`	`http`	`read`
`/api/endpoints/+`	`http`	`readWrite`

Mappings¶

/resources/mappings

Allows the listing of all mappings through HTTP

Resource	Context	Operation
`/api/mappings/+`	`http`	`read`
`/api/mappings`	`http`	`read`

Alternatively: Allows the managing of all mappings through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all mappings through HTTP and going to the mapping’s details page

Resource	Context	Operation
`/api/mappings/+/endpoint-topics`	`http`	`read`
`/api/mappings/+`	`http`	`read`
`/api/mappings`	`http`	`read`

Allows the managing of all mappings through HTTP

Resource	Context	Operation
`/api/mappings/+/operation`	`http`	`write`
`/api/mappings/+`	`http`	`readWrite`
`/api/mappings`	`http`	`read`

Mapping¶

/mappings/:id

Allows the loading of a single mapping through HTTP

Resource	Context	Operation
`/api/mappings/+/endpoint-topics`	`http`	`read`
`/api/mappings/+`	`http`	`read`

Alternatively: Allows the loading of a single mapping through MQTT and managing of the loaded mapping

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of a single mapping through HTTP and managing of the loaded mapping

Resource	Context	Operation
`/api/mappings/+/endpoint-topics`	`http`	`read`
`/api/mappings/+/operation`	`http`	`write`
`/api/mappings/+`	`http`	`readWrite`

Allows the loading of a single mapping through HTTP

Resource	Context	Operation
Any	`mqtt`	`read`
`/api/mappings/+/endpoint-topics`	`http`	`read`
`/api/mappings/+`	`http`	`read`

Servers¶

/resources/servers

Allows the listing of all servers through HTTP

Resource	Context	Operation
`/api/servers`	`http`	`read`

Alternatively: Allows the managing of all servers through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all servers through HTTP

Resource	Context	Operation
`/api/servers/+`	`http`	`read`
`/api/servers`	`http`	`read`

Allows the managing of all servers through HTTP

Resource	Context	Operation
`/api/servers/+/operation`	`http`	`write`
`/api/servers`	`http`	`read`

Server¶

/servers/:id

Allows the loading of a single server through HTTP

Resource	Context	Operation
`/api/servers/+`	`http`	`read`

Alternatively: Allows the loading of a single server through MQTT and managing of the loaded server

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of a single server through HTTP and managing of the loaded server

Resource	Context	Operation
`/api/servers/+/operation`	`http`	`write`
`/api/servers/+`	`http`	`read`

Allows the loading of a single server through HTTP and list its nodes

Resource	Context	Operation
`/api/nodes`	`http`	`read`
`/api/servers/+`	`http`	`read`

Service Links¶

/resources/services-links

Allows the listing of service links through HTTP

Resource	Context	Operation
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Alternatively: Allows the listing of service links through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of service links through HTTP and going to the service’s details page

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Volumes¶

/resources/volumes

Allows the listing of all volumes through HTTP

Resource	Context	Operation
`/api/volumes`	`http`	`read`

Alternatively: Allows the managing of all volumes through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all volumes through HTTP and going to the volume’s details page

Resource	Context	Operation
`/api/volumes/+/inspect`	`http`	`read`
`/api/volumes`	`http`	`read`

Volume¶

/volumes/:id

Allows the loading of a single volume through HTTP

Resource	Context	Operation
`/api/volumes/+/inspect`	`http`	`read`

Alternatively: Allows the loading of a single volume through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Service Catalog¶

/catalog

Allows the use of service catalog through HTTP

Resource	Context	Operation
`/api/marketplace/app/meta`	`http`	`read`
`/api/marketplace/app`	`http`	`read`
`/api/marketplace/apps`	`http`	`read`
`/api/services`	`http`	`write`

Services¶

/services

Allows the listing of all services through HTTP

Resource	Context	Operation
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Alternatively: Allows the listing and managing of all services through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the listing of all services through HTTP and going to the service’s details page

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`

Allows the managing of all services through HTTP

Resource	Context	Operation
`/api/services/+/operation`	`http`	`write`
`/api/services/+`	`http`	`readWrite`
`/api/services`	`http`	`read`

Allows the listing, creation and update of all services through HTTP

Resource	Context	Operation
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`readWrite`

Alternatively: Allows the listing and managing of all services through MQTT, with creation and update done through HTTP

Resource	Context	Operation
`#`	`mqtt`	`readWrite`
`/api/services`	`http`	`write`

Service¶

/services/:id

Allows the loading of a single service through HTTP

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Alternatively: Allows the loading and managing of the loaded service through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of a single service through HTTP and managing of the loaded service

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+/operation`	`http`	`write`
`/api/services/+`	`http`	`readWrite`

Allows the loading and update of a single service through HTTP

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`write`

Alternatively: Allows the loading and managing of the loaded service through MQTT, with update done through HTTP

Resource	Context	Operation
`#`	`mqtt`	`readWrite`
`/api/services`	`http`	`write`

Allows the loading of a single service through HTTP and viewing its related connections

Resource	Context	Operation
`/api/connections`	`http`	`read`
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Allows the loading of a single service through HTTP and viewing its related containers

Resource	Context	Operation
`/api/containers/+/inspect`	`http`	`read`
`/api/containers/orchestrator`	`http`	`read`
`/api/containers`	`http`	`read`
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Allows the loading of a single service through HTTP and viewing its related endpoints

Resource	Context	Operation
`/api/endpoints/+`	`http`	`read`
`/api/endpoints`	`http`	`read`
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Allows the loading of a single service through HTTP and viewing its related mappings

Resource	Context	Operation
`/api/mappings/+`	`http`	`read`
`/api/mappings`	`http`	`read`
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Allows the loading of a single service through HTTP and viewing its related servers

Resource	Context	Operation
`/api/servers`	`http`	`read`
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`

Allows the loading of a single service through HTTP and viewing its related volumes

Resource	Context	Operation
`/api/services/+/dependencies`	`http`	`read`
`/api/services/+`	`http`	`read`
`/api/volumes`	`http`	`read`

System¶

Agents¶

/agents

Allows the loading of agents through HTTP

Resource	Context	Operation
`/api/system/agents`	`http`	`read`

Alternatively: Allows the loading of agents through MQTT and managing of the loaded agents

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Info¶

/info

Allows the loading of license and connectivity information

Resource	Context	Operation
`/api/system/info`	`http`	`read`
`/api/system/preflight`	`http`	`read`

Allows the loading of services through HTTP

Resource	Context	Operation
`/api/services/+`	`http`	`read`
`/api/services`	`http`	`read`
`/api/system/info`	`http`	`read`
`/api/system/preflight`	`http`	`read`

Alternatively: Allows the loading of services through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`
`/api/system/info`	`http`	`read`
`/api/system/preflight`	`http`	`read`

Allows the user to update the license

Resource	Context	Operation
`/api/system/info`	`http`	`read`
`/api/system/licensefile`	`http`	`write`
`/api/system/preflight`	`http`	`read`
`/api/system/refresh`	`http`	`read`

Metrics¶

/metrics

Allows the user to see the usage metrics

Resource	Context	Operation
`/api/system/metrics`	`http`	`read`
`/api/system/preflight`	`http`	`read`

Allows the user send metrics to the portal

Resource	Context	Operation
`/api/system/metrics`	`http`	`readWrite`
`/api/system/preflight`	`http`	`read`

Status¶

/status

Allows the loading of all core containers through HTTP

Resource	Context	Operation
`/api/core-containers/+/inspect`	`http`	`read`
`/api/core-containers/orchestrator`	`http`	`read`
`/api/core-containers`	`http`	`read`

Alternatively: Allows the managing of all the core containers through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the loading of all core containers through HTTP

Resource	Context	Operation
`/api/core-containers/+/inspect`	`http`	`read`
`/api/core-containers/+/operation`	`http`	`write`
`/api/core-containers/orchestrator`	`http`	`read`
`/api/core-containers`	`http`	`read`

Status¶

/status/:id

Allows the loading of a single core container through HTTP

Resource	Context	Operation
`/api/core-containers/+/inspect`	`http`	`read`

Alternatively: Allows the managing of a single core container through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`

Allows the managing of a single core container through HTTP

Resource	Context	Operation
`/api/core-containers/+/inspect`	`http`	`read`
`/api/core-containers/+/operation`	`http`	`write`

Tools¶

Data Explorer¶

/explorer

Allows the loading of the Explorer metadata through HTTP

Resource	Context	Operation
Any	`mqtt`	`read`
`/api/endpoints/+/state`	`http`	`read`
`/api/mappings/+/state`	`http`	`read`
`/api/nodes/+/state`	`http`	`read`
`/api/topics`	`http`	`read`

Alternatively: Allows the loading of the Explorer metadata through MQTT

Resource	Context	Operation
`#`	`mqtt`	`readWrite`
`/api/topics`	`http`	`read`

Rule Sandbox¶

/rule-engine-sandbox

Resource	Context	Operation
Any	`mqtt`	`read`
`/api/endpoints`	`http`	`read`
`/api/rule-engine/+`	`http`	`readWrite`
`/api/topics`	`http`	`read`

User Management¶

Certificates¶

/certificates

Resource	Context	Operation
`/api/certificates/+`	`http`	`readWrite`
`/api/certificates`	`http`	`readWrite`

Client Registry¶

/client-registry

Resource	Context	Operation
`/api/client-registry/+`	`http`	`readWrite`
`/api/client-registry`	`http`	`readWrite`

Users and Roles¶

/user-and-roles

Resource	Context	Operation
`/api/listUsers`	`http`	`read`
`/api/policy/password`	`http`	`read`
`/api/roles/#`	`http`	`readWrite`
`/api/roles`	`http`	`readWrite`
`/api/users/#`	`http`	`readWrite`

Workbench¶

Resource	Context	Operation
`/workbench/#`	`http`	`readWrite`
`/workbench`	`http`	`readWrite`