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
serect	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
appServersLimit	Integer	N	Indicates, if the number of application server /system-info responses should be limited in total

Example Response

JSON
    
xxxxxxxxxx
 
{    "versionInfo":    {        "name": "fsBroker",        "version": "1.0.0",        "copyright": "Copyright 2020 Jan Miller, All Rights Reserved,www.filescan.io"    },    "queueInfo":    {        "queueCount": 0    },    "memoryStats":    {        "usedMemory": 21,        "freeMemory": 538,        "totalMemory": 560,        "maxMemory": 14492    },    "freeDiscSpaceInMb":    {        "Samples": 1833809,        "fsBrokerQueue": 1833809,        "fsBrokerResults": 1833809,        "fsTemp": 79668    }}
Copy

Last updated on

Was this page helpful?