Skip to main content
API docs by Redocly

Maps Messaging Rest Server (00.00.00-SNAPSHOT)

Download OpenAPI specification:Download

Info MapsMessaging B.V.: [email protected] URL: http://mapsmessaging.io License: Apache 2.0

Maps Messaging Server Rest API, provides simple Rest API to manage and interact with the server

Maps Messaging

Authentication and Authorisation Management

Provides endpoints for managing user authentication and authorisation, including login, logout, token management, and role-based access control to ensure secure interactions with the server.

Get all groups

Retrieves all currently known groups. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=name = 'admin'

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add new group

Adds a new group to the group list. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
Request Body schema: */*
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Add user to group

Adds a user to a group using the UUID of the user and UUID of the group . Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
groupUuid
required
string
userUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Removes a user from group

Removes a user from a group using the users UUID and the groups UUID . Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
groupUuid
required
string
userUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Get group by UUID

Retrieve the group using the UUID of the specific group. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
groupUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "admin",
  • "uniqueId": "e808afcb-1ff9-46cd-a322-3119dbf1d071",
  • "usersList": [
    ]
}

Delete a group

Deletes a group from the list and removes all user memberships. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
groupUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Get all currently locked users

Retrieves all currently known users that are locked out due to failed log in attempts.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unlocks a user that is currently locked due to invalid login attempts

When a user exceeds the failed login attempts they are locked out for a period of time

Authorizations:
basicAuthauthScheme
path Parameters
userUuid
required
string

Responses

Get all users

Retrieves all currently known users filtered by the optional filter string, SQL like syntax. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=username = 'bill'

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new user

Adds a new user to the system. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
Request Body schema: */*
username
required
string (Username)

The unique username for the new user account.

password
required
string (Password)

The password or passphrase for the new user, intended to provide secure access.

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Change user password

Change the password for a user. Admin may reset any user. A user may change their own password; currentPassword may be required depending on policy.

Authorizations:
basicAuthauthScheme
path Parameters
userUuid
required
string
Request Body schema: application/json
newPassword
required
string (New Password) non-empty

The new password to set.

Responses

Request samples

Content type
application/json
{
  • "newPassword": "NewStrongerPassword123!"
}

Get user by username

Retrieve the user by username. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
userUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "username": "myUserName",
  • "uniqueId": "83db8741-57ca-4147-a973-49789d9150bb",
  • "groupList": [
    ],
  • "attributes": {
    }
}

Delete a user

Deletes a user from the system. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
userUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Destination Management

Facilitates the management of destinations such as topics and queues. Includes operations for creating, updating, deleting, and querying destinations, as well as managing subscriptions.

Retrieve a paginated list of destinations/folders at the specified namespace

Fetch a paginated list of all known destinations. You can filter the list using a selector string, limit the number of returned entries using the 'size' parameter, and sort the results by attributes such as Name, Published Messages, or Stored Messages. Cached results are returned if available to enhance performance. Authentication is required if the server configuration mandates it.

Authorizations:
basicAuthauthScheme
query Parameters
prefix
string or null
Example: prefix=/a/b

Namespace prefix to browse. Leading '/' is significant. Server normalizes duplicate and trailing slashes. Empty means root.

pageSize
integer <int32> [ 10 .. 1000 ]
Default: 100
Example: pageSize=50

Maximum number of entries returned in this page.

pageNumber
integer <int32> >= 0
Default: 0
Example: pageNumber=0

Zero-based page number.

header Parameters
If-None-Match
string

Responses

Response samples

Content type
application/json
{
  • "totalEntries": 237,
  • "totalPages": 5,
  • "pageNo": 0,
  • "entries": [
    ]
}

Retrieve a list of all destinations with optional filtering and sorting

Fetch a paginated list of all known destinations. You can filter the list using a selector string, limit the number of returned entries using the 'size' parameter, and sort the results by attributes such as Name, Published Messages, or Stored Messages. Cached results are returned if available to enhance performance. Authentication is required if the server configuration mandates it.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=type = 'topic' AND storedMessages > 50

An optional filter string for selecting specific destinations. The filter should be a valid expression that complies with the selector syntax.

size
integer <int32>
Default: 40
Example: size=100

The maximum number of destinations to return in the response. A default value is used if this parameter is not provided.

sortBy
string
Default: "Published"
Enum: "Name" "Published" "Delivered" "Stored" "Pending" "Delayed" "Expired"
Example: sortBy=Published

The attribute by which the list of destinations should be sorted before returning. Possible values include Name, Published, Delivered, Stored, Pending, Delayed, and Expired.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve detailed information about a destination

Fetch detailed information for a specific destination identified by its name. Authentication is required if the server configuration mandates it. Cached results are returned if available to enhance performance.

Authorizations:
basicAuthauthScheme
query Parameters
destinationName
required
string
Example: destinationName=destination-01

The name of the destination for which details are requested

Responses

Response samples

Content type
application/json
{
  • "destination": {
    },
  • "subscriptionList": [
    ]
}

Messaging Interface

Offers APIs for sending and receiving messages, enabling communication between clients and the server. Supports various messaging protocols and real-time event handling.

Abort the message

Abort the message specifed by the id and the destination name

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destinationName
string
eventIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "destinationName": "string",
  • "eventIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Commit the message

Commit the message specifed by the id and the destination name

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destinationName
string
eventIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "destinationName": "string",
  • "eventIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Get messages

Retrieves messages for a specified subscription

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destination
string (Destination name)

Optional, if supplied gets any messages outstanding for this destination, else all messages pending delivery

depth
integer <int32> (Depth)
Default: 10

The max number of events that should be returned

Responses

Request samples

Content type
application/json
{
  • "destination": "topicName",
  • "depth": 60
}

Response samples

Content type
application/json
{
  • "consumedMessages": [
    ]
}

Get message depth

Get the depth of the queue for a specified subscription

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destination
string (Destination name)

Optional, if supplied gets any messages outstanding for this destination, else all messages pending delivery

depth
integer <int32> (Depth)
Default: 10

The max number of events that should be returned

Responses

Request samples

Content type
application/json
{
  • "destination": "topicName",
  • "depth": 60
}

Response samples

Content type
application/json
{
  • "subscriptionDepths": [
    ]
}

Publish a message

Publishes a message to a specified topic

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destinationName
required
string (Destination Topic)

The topic to which the message will be published. This should be a valid topic name recognized by the messaging system.

required
object (Message)

Represents a messaging entity with configurable quality, priority, and metadata attributes.

retain
boolean (Retain Message)
Default: false

Indicates if the message should be retained on the destination. If true, the message will be stored and sent to new subscribers on the topic.

Responses

Request samples

Content type
application/json
{
  • "destinationName": "sensor/data",
  • "message": {
    },
  • "retain": false
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Request a temporary token to access the listed destinations events

Retrieve a temporary token that allows access to the destinations event stream

Authorizations:
basicAuthauthScheme
query Parameters
destination
string

Responses

Expose AsyncMessageDTO in OpenAPI

Delivers messages via Server Side Events, supports MQTT wild card plus JMS style filtering

Authorizations:
basicAuthauthScheme
path Parameters
token
required
string
query Parameters
destinationName
required
string (Destination Name)
Example: destinationName=sensor/data or /sensor/#

The name of the destination (e.g., topic or queue) to which the subscription is bound.Supports MQTT style wild card subscription

namedSubscription
string or null (Named Subscription)
Example: namedSubscription=temperatureAlerts

An optional name for a named subscription, allowing clients to re-use existing subscriptions if provided.

filter
string or null (Filter Expression)
Example: filter=temperature > 25

An optional filter expression written in JMS selector syntax to filter messages received by the subscription.

maxDepth
integer or null <int32> (Maximum Queue Depth)
Default: 1
Example: maxDepth=10

The maximum number of messages that can be queued for the subscription before new messages are dropped.

retainMessage
boolean or null (Retain Message)
Default: false
Example: retainMessage=false

Indicates if messages should be retained on the destination for this subscription, meaning they will be stored and made available to future subscribers.

Responses

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "payload": "VGhpcyBpcyBhIGV4YW1wbGUgZGF0YS4=",
  • "contentType": "application/json",
  • "correlationData": "WzEsMiwzLDRd",
  • "expiry": 60000,
  • "priority": 4,
  • "qualityOfService": 1,
  • "creation": "2019-08-24T14:15:22Z",
  • "dataMap": {
    },
  • "metaData": {
    },
  • "destinationName": "/folder/topic"
}

Subscribe to a topic

Subscribes to a specified topic

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destinationName
required
string (Destination Name)

The name of the destination (e.g., topic or queue) to which the subscription is bound.Supports MQTT style wild card subscription

namedSubscription
string or null (Named Subscription)

An optional name for a named subscription, allowing clients to re-use existing subscriptions if provided.

filter
string or null (Filter Expression)

An optional filter expression written in JMS selector syntax to filter messages received by the subscription.

maxDepth
integer or null <int32> (Maximum Queue Depth)
Default: 1

The maximum number of messages that can be queued for the subscription before new messages are dropped.

transactional
boolean (Transactional subscription)
Default: false

Flag to indicate the subscription is transactional

retainMessage
boolean or null (Retain Message)
Default: false

Indicates if messages should be retained on the destination for this subscription, meaning they will be stored and made available to future subscribers.

Responses

Request samples

Content type
application/json
{
  • "destinationName": "sensor/data or /sensor/# ",
  • "namedSubscription": "temperatureAlerts",
  • "filter": "temperature > 25",
  • "maxDepth": 10,
  • "transactional": true,
  • "retainMessage": false
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Unsubscribe from a topic

Unsubscribes from a specified topic

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
destinationName
required
string (Destination Name)

The name of the destination (e.g., topic or queue) to which the subscription is bound.Supports MQTT style wild card subscription

namedSubscription
string or null (Named Subscription)

An optional name for a named subscription, allowing clients to re-use existing subscriptions if provided.

filter
string or null (Filter Expression)

An optional filter expression written in JMS selector syntax to filter messages received by the subscription.

maxDepth
integer or null <int32> (Maximum Queue Depth)
Default: 1

The maximum number of messages that can be queued for the subscription before new messages are dropped.

transactional
boolean (Transactional subscription)
Default: false

Flag to indicate the subscription is transactional

retainMessage
boolean or null (Retain Message)
Default: false

Indicates if messages should be retained on the destination for this subscription, meaning they will be stored and made available to future subscribers.

Responses

Request samples

Content type
application/json
{
  • "destinationName": "sensor/data or /sensor/# ",
  • "namedSubscription": "temperatureAlerts",
  • "filter": "temperature > 25",
  • "maxDepth": 10,
  • "transactional": true,
  • "retainMessage": false
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Server Health

Includes endpoints for monitoring the server's health and operational status, providing simple and detailed responses for status checks and diagnostics.

Check server health

Checks the health of all subsystems and returns their overall status. Possible values are 'Ok', 'Warning', or 'Error'.

Authorizations:
basicAuthauthScheme

Responses

Check for configuration updates

Provides information about any changes in the server's configuration update counts.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "schemaUpdate": 0,
  • "destinationUpdate": 0,
  • "interfaceUpdate": 0
}

Retrieve the server's unique name

Returns the unique identifier of the server instance.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
"string"

Ping the server

A simple endpoint to verify that the server is operational and responsive.

Authorizations:
basicAuthauthScheme

Responses

Server Interface Management

Manages the server's network interfaces, including configuration, monitoring, and troubleshooting of connections to ensure optimal performance and reliability.

Get end point configurations

Get the end point configuration specifed by the name. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
endpoint
required
string

Responses

Response samples

Content type
application/json
{
  • "schemaLoadingVersion": 1,
  • "uniqueId": "string",
  • "name": "myInterface",
  • "port": 8080,
  • "host": "http://localhost",
  • "state": "Started",
  • "config": {
    }
}

Update end point configuration

Update the configuration supplied for the named endpoint.

Authorizations:
basicAuthauthScheme
path Parameters
endpoint
required
string
Request Body schema: */*
schemaLoadingVersion
integer or null <int32> [ 0 .. 10 ]
Default: 1

Configuration schema version. 0 = legacy format, 1 = current format.

name
required
string

Name of the endpoint server

url
required
string [ 1 .. 2048 ] characters ^(tcp|ssl|udp|dtls|ws|wss|serial)://[^\s]+$

URL for the endpoint server

required
object (EndPointConfigDTO)

Abstract base class for all schema configurations

object or null (SASL Configuration DTO)

Represents the configuration for SASL authentication used for REST communication.

required
Array of objects (ProtocolConfigDTO) non-empty [ items non-empty ]

List of protocol configurations for the endpoint

authenticationRealm
required
string

Authentication realm

backlog
integer or null <int32> [ 1 .. 10000 ]
Default: 100

Backlog for the endpoint server

selectorTaskWait
integer or null <int32> [ 1 .. 1000 ]
Default: 10

Selector task wait time

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Controls the specific end point

Applies the requested state to all configured interface endpoints.

Authorizations:
basicAuthauthScheme
path Parameters
endpoint
required
string
Request Body schema: application/json
required

Requested action to apply to all inter-server connections

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Get end point connections

Get current connections on this endpoint. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
endpoint
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get end point status

Get the current status and metrics for the specified end point.

Authorizations:
basicAuthauthScheme
path Parameters
endpoint
required
string

Responses

Response samples

Content type
application/json
{
  • "interfaceName": "myInterface",
  • "totalBytesSent": 1024000,
  • "totalBytesReceived": 2048000,
  • "totalMessagesSent": 500,
  • "totalMessagesReceived": 480,
  • "bytesSent": 1000,
  • "bytesReceived": 2000,
  • "messagesSent": 5,
  • "messagesReceived": 4,
  • "connections": 10,
  • "errors": 3,
  • "statistics": {
    }
}

Get all end point status

Get all end point statuses and metrics, fitlered with the optional filter.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=state = 'started'

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all end point details

get all end point configuration details, filtered with the optional filter.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=state = 'started'

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Manages all end points

Manages actions on all endpoints.

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
required

Requested action to apply to all inter-server connections

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Schema Management

Provides functionality to configure, manage, and query schemas used by the server, enabling seamless integration with structured data formats and validation mechanisms.

Get all schemas

Retrieves all schema configurations, optionally filtered by a query string.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add new schema

Adds a new schema configuration to the system.

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
schema
string (Schema)

A JSON-encoded string representing the schema object to be posted.

context
string (Context)

The name or context of the schema, identifying the scope or purpose for which it is used.

Responses

Request samples

Content type
application/json
{
  • "schema": "{\"type\":\"record\",\"name\":\"User\",\"fields\":[{\"name\":\"id\",\"type\":\"string\"}]}",
  • "context": "UserProfile"
}

Response samples

Content type
application/json
"string"

Delete all schemas

Deletes all schemas, optionally filtered by a query string.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string

Responses

Response samples

Content type
application/json
"string"

Get specific schema

Retrieves the details of a specific schema by its unique ID.

Authorizations:
basicAuthauthScheme
path Parameters
schemaId
required
string

Responses

Response samples

Content type
application/json
"string"

Delete specific schema

Deletes a schema configuration by its unique ID.

Authorizations:
basicAuthauthScheme
path Parameters
schemaId
required
string

Responses

Response samples

Content type
application/json
"string"

Get supported formats

Retrieves a list of all known schema formats supported by the system.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get link-format configuration

Retrieves the link-format configuration list.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
"string"

Get schemas by context

Retrieves all schemas that match the specified context.

Authorizations:
basicAuthauthScheme
path Parameters
context
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get schemas by type

Retrieves all schemas that match the specified type.

Authorizations:
basicAuthauthScheme
path Parameters
type
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get specific schema definition

Retrieves the schema artifact bytes by unique ID.

Authorizations:
basicAuthauthScheme
path Parameters
schemaId
required
string

Responses

Get schema mappings

Retrieves all schemas and their associated mapping information.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Server Management

Includes operations for monitoring and managing the server's status, configurations, and performance metrics to ensure smooth and efficient operation.

Get server build information

Retrieves detailed information about the server build, such as version and configuration details. Uses caching for improved performance.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "serverName": "maps-server",
  • "version": "3.3.7",
  • "buildDate": "2024-10-13",
  • "totalMemory": 536870912,
  • "maxMemory": 1073741824,
  • "freeMemory": 268435456,
  • "numberOfThreads": 120,
  • "timeToCreateNano": 1000000,
  • "uptime": 123456789,
  • "connections": 150,
  • "destinations": 30,
  • "cpuTime": 1234567890,
  • "cpuPercent": 12.5,
  • "storageSize": 104857600,
  • "threadState": {
    }
}

Get server statistics

Retrieves server usage statistics, including metrics such as CPU usage, memory usage, and active connections. Uses caching for improved performance.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "packetsSent": 1024,
  • "packetsReceived": 2048,
  • "totalReadBytes": 5242880,
  • "totalWriteBytes": 4194304,
  • "totalConnections": 150,
  • "totalDisconnections": 145,
  • "totalNoInterestMessages": 10,
  • "totalSubscribedMessages": 5000,
  • "totalPublishedMessages": 6000,
  • "totalRetrievedMessages": 2500,
  • "totalExpiredMessages": 20,
  • "totalDeliveredMessages": 4000,
  • "publishedPerSecond": 50,
  • "subscribedPerSecond": 45,
  • "noInterestPerSecond": 5,
  • "deliveredPerSecond": 60,
  • "retrievedPerSecond": 30,
  • "stats": "{\"latency\": {\"name\": \"latency\", \"unitName\": \"ms\", \"current\": 10, ...}}"
}

Get server subsystem status summary

Returns a simple summary of the server status.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "issueCount": 0
}

Get server subsystem status

Retrieves the current status of all server subsystems, including their operational state (e.g., OK, Warning, or Error). Uses caching for improved performance.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restart or shutdown the server

Restarts or shuts down the server gracefully, preserving any necessary state before the restart operation begins.

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
required

Requested action to apply to all inter-server connections

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
"string"

Server Integration Management

Manages the server's integrations with other messaging brokers, enabling interoperability and seamless data exchange across distributed systems.

Get integration by name

Retrieves the configuration on the inter-server integration connection. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "state": "string"
}

Manages inter-server connection

Handles state for the inter-server connection

Authorizations:
basicAuthauthScheme
path Parameters
name
required
string
Request Body schema: application/json
required

Requested action to apply to inter-server connection

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Get integration status by name

Retrieves the current status on the inter-server integration connection. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "adapter": "string",
  • "name": "string",
  • "user": "string",
  • "protocolName": "string",
  • "protocolVersion": "string",
  • "proxyAddress": "string",
  • "connectedTimeMs": 0,
  • "lastRead": 0,
  • "lastWrite": 0,
  • "totalBytesRead": 0,
  • "totalBytesWritten": 0,
  • "totalOverflow": 0,
  • "totalUnderflow": 0,
  • "bytesRead": 0,
  • "bytesWritten": 0,
  • "overFlow": 0,
  • "underFlow": 0
}

Get inter-server status

Retrieve the current status for the inter-server specified by name. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "interfaceName": "myInterface",
  • "bytesSent": 123456,
  • "bytesReceived": 654321,
  • "messagesSent": 100,
  • "messagesReceived": 95,
  • "errors": 2,
  • "lastReadTime": 1625812345678,
  • "lastWriteTime": 1625812345678,
  • "state": "active",
  • "statistics": "{\"averageRead\": {\"name\": \"averageRead\", \"unitName\": \"bytes\", \"current\": 50, ...}}"
}

Get all inter-server status

Retrieve all current statuses for the inter-server. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=state = PAUSED

Optional filter string

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

Get all inter-server connections

Retrieves a list of all inter-server configurations. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=state = PAUSED

Optional filter string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "globalConfig": {
    }
}

Manages all inter-server connections

Handles state for all inter-server connections

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
required

Requested action to apply to all inter-server connections

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Server Integration Status

Retrieves the current status of the server to server integration.

Connection Management

Handles client connections to the server, offering endpoints for monitoring, managing, and troubleshooting active connections and session details.

Get connection details for the specified id

Retrieve the details of the specified connection id. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
connectionId
required
string

Responses

Response samples

Content type
application/json
{
  • "endPointSummary": {
    },
  • "protocolInformation": {
    }
}

Close a connection

Requests the connection specified be closed. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
path Parameters
connectionId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Get all connections

Retrieve a list of all current connections to the server, can be filtered with the optional filter string. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme
query Parameters
filter
string
Example: filter=totalOverflow > 10 OR totalUnderflow > 5

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Discovery Management

Provides mechanisms for managing the server's discovery agents, allowing automated detection and configuration of network services and resources.

Get discovered servers

Retrieve a list of all currently discovered servers, can be filtered with the optional filter. Requires authentication if enabled in the configuration.

Authorizations:
basicAuth
query Parameters
filter
string
Example: filter=schemaSupport = TRUE OR systemTopicPrefix IS NOT NULL

Optional filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Manages the discovery manager

Manages the state of the discovery manager

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
required

Requested action to apply to all inter-server connections

state
string

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Hardware Management

Enables the management of hardware devices integrated with the server, including configuration, monitoring, and diagnostics for seamless hardware-software interaction.

Get known devices

Retreive a list of all detected devices currently online. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scan for new hardware

Requests a scan to detect new hardware on I2C bus or configured devices. Requires authentication if enabled in the configuration.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • "string"
]

LoRa Device Management

Offers APIs for managing LoRa devices, including adding, updating, retrieving configurations, monitoring device statistics, and managing endpoint connections.

Retrieve all LoRa devices

Fetches a list of all LoRa devices along with their configurations and statistics.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a specific LoRa device

Fetches the details of a specific LoRa device identified by its name.

Authorizations:
basicAuthauthScheme
path Parameters
deviceName
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "LoRaDevice_01",
  • "radio": "SX1276",
  • "bytesSent": 1048576,
  • "bytesReceived": 2048000,
  • "packetsSent": 500,
  • "packetsReceived": 480,
  • "endPointInfoList": [
    ]
}

Retrieve endpoint connections for a LoRa device

Fetches the connection information for a specific endpoint of a LoRa device, identified by the device name and node ID.

Authorizations:
basicAuthauthScheme
path Parameters
deviceName
required
string
nodeId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Logging Monitor

Offers simple API to retrieve server logs or to stream server logs via SSE

Get last stored log entries

Retrieve the last configured number of log entries from the server

Authorizations:
basicAuthauthScheme
query Parameters
filter
string

Responses

Response samples

Content type
application/json
{
  • "logEntries": [
    ]
}

Request a temporary token to access the server side logs

Retrieve a temporary token that allows access to the server side log stream

Authorizations:
basicAuthauthScheme

Responses

Stream live log entries

Subscribe to dynamic log events using Server-Sent Events

Authorizations:
basicAuthauthScheme
path Parameters
token
required
string
query Parameters
filter
string

Responses

User Authentication

Provides the rest api login, logout and token refresh

Returns the current authentication session

Returns information about the current user authentication session, can be used to see if the user is logged in

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "schemaUpdate": 0,
  • "destinationUpdate": 0,
  • "interfaceUpdate": 0
}

User login

Allows a user to log in and obtain an authentication token. This endpoint does not require authentication and overrides global security settings.

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
username
string

The username for login

password
string

The password for login

persistent
boolean

Whether the session should be persistent

sessionId
string

Optional client-provided session ID

longLived
boolean

Request a long-lived session (e.g. 7 days)

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "password": "P@ssw0rd!",
  • "persistent": true,
  • "sessionId": "session-12345",
  • "longLived": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "username": "string",
  • "accessMap": {
    },
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44"
}

User logout

Logs out the currently authenticated user by invalidating their session.

Authorizations:
basicAuthauthScheme

Responses

Refreshes the users JWT

Refreshes the current JWT cookie used for auth.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "username": "string",
  • "accessMap": {
    },
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44"
}

ML Model Store

Endpoints for managing ML models in the system.

Download model

Downloads a model by name.

Authorizations:
basicAuthauthScheme
path Parameters
modelName
required
string

Responses

ML Model upload

uploads a model

Authorizations:
basicAuthauthScheme
path Parameters
modelName
required
string
Request Body schema: multipart/form-data
file
object

Responses

Delete model

Deletes the model by name.

Authorizations:
basicAuthauthScheme
path Parameters
modelName
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Check if model exists

Checks if a model with the given name exists.

Authorizations:
basicAuthauthScheme
path Parameters
modelName
required
string

Responses

List all models

Returns a list of all available model names.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • "string"
]

Check access for an identity to a resource

Checks whether the identity has the specified permission on the given resource

Authorizations:
basicAuthauthScheme
Request Body schema: application/json
identityId
required
string

Identity identifier

resourceType
required
string

Resource type

resourceKey
required
string

Resource key or identifier

permission
required
string

Permission name to check

explain
boolean

If true, the server should include human readable explanation

Responses

Request samples

Content type
application/json
{
  • "identityId": "admin",
  • "resourceType": "TOPIC",
  • "resourceKey": "/sensors/room1/temp",
  • "permission": "publish",
  • "explain": true
}

Response samples

Content type
application/json
{
  • "decision": "ALLOW",
  • "permission": "publish",
  • "reason": "string",
  • "sources": [
    ]
}

Get the authorisation permission list

Retrieves the read only permissions used by the servers Authorisation

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "schemaLoadingVersion": 1,
  • "permissions": "CONNECT, PUBLISH",
  • "resourceTypes": "server, topic, queue"
}

Get explicit ACL entries for a group

Retrieves explicit ACL entries for the specified group, grouped by resource

Authorizations:
basicAuthauthScheme
path Parameters
groupUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "principalType": "IDENTITY",
  • "principalId": "admin",
  • "entries": [
    ]
}

Get explicit ACL entries for an identity

Retrieves explicit ACL entries for the specified identity, grouped by resource

Authorizations:
basicAuthauthScheme
path Parameters
userUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "principalType": "IDENTITY",
  • "principalId": "admin",
  • "entries": [
    ]
}

Get the ACL for a specific resource

Retrieves explicit ACL entries for the given resource

Authorizations:
basicAuthauthScheme
query Parameters
resourceType
required
string
Example: resourceType=TOPIC

Resource type

resourceKey
required
string
Example: resourceKey=/sensors/room1/temp

Resource key or identifier

Responses

Response samples

Content type
application/json
{
  • "resourceType": "TOPIC",
  • "resourceKey": "/sensors/room1/temp",
  • "entries": [
    ]
}

Replace the ACL for a specific resource

Replaces the explicit ACL entries for the given resource with the provided set

Authorizations:
basicAuthauthScheme
query Parameters
batchTimeoutMillis
integer <int64>
Default: 5000
Request Body schema: application/json
resourceType
required
string

Resource type

resourceKey
required
string

Resource key or identifier

required
Array of objects (AclEntryDTO)

New set of ACL entries for this resource (explicit only)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "TOPIC",
  • "resourceKey": "/sensors/room1/temp",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "TOPIC",
  • "resourceKey": "/sensors/room1/temp",
  • "entries": [
    ]
}

getExternalGrammar

Authorizations:
basicAuthauthScheme
path Parameters
path
required
string

Responses

getWadl

Authorizations:
basicAuthauthScheme

Responses

Server Config Management

List configuration sections

Returns the list of known top-level configuration managers/sections.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
[
  • "string"
]

Retrieve configuration section value and schema

Returns the current configuration section value and its JSON Schema in a single response.

Authorizations:
basicAuthauthScheme
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "schema": { }
}

Retrieve cache information

Fetches detailed information about the server's central cache, including size, usage statistics, and entries.

Authorizations:
basicAuthauthScheme

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "lifeTime": 0,
  • "scanTime": 0,
  • "cacheSize": 0,
  • "cacheHits": 0,
  • "cacheMisses": 0
}

Clear cache

Clears all entries in the server's central cache to free up memory and ensure data consistency.

Authorizations:
basicAuthauthScheme

Responses