System Info Endpoint

Broker System Info Endpoint

This API endpoint allows retrieval of basic system stats, such as the version, name, queue size, disc usage and memory footprint.

Syntax

GET https://<ip>:<port>/system-info

Parameters

Name	Type	Required?	Description
secret	String	Y	Authentication secret
appServers	Boolean	N	Indicates, whether or not a subset of the /system-info response of fsTransform application servers should be returned

Example Response

{

"versionInfo":

{

"name": "broker",

"version": "1.0.0",

"queueInfo":

{

"queueCount": 0

"memoryStats":

{

"usedMemory": 21,

"freeMemory": 538,

"totalMemory": 560,

"maxMemory": 14492

"freeDiscSpaceInMb":

{

"Samples": 1833809,

"fsBrokerQueue": 1833809,

"fsBrokerResults": 1833809,

"fsTemp": 79668

}

Transform System Info Endpoint

This API endpoint allows retrieval of basic system stats, such as the version, name, queue size, disc usage and memory footprint.

Syntax

GET https://<ip>:<port>/system-info

Parameters

Name	Type	Required?	Description
secret	String	Y	Authentication secret

Example Response

{

"versionInfo":

{

"name": "transform",

"version": "1.0.0",

"queueInfo":

{

"activeCount": 0,

"queueCount": 0,

"completedCount": 0

"memoryStats":

{

"usedMemory": 556,

"freeMemory": 1103,

"totalMemory": 1660,

"maxMemory": 3641

"freeDiscSpaceInMb":

{

"fsResources": 26970,

"fsResults": 67967,

"fsTasks": 26970

"activeThreads": 5,

"systemEvents":

{},

Last updated on

Was this page helpful?