The Get Server Properties API

Using the Get Server Properties API, you can view the list of properties of a server.
METHOD GET
URI 
https://<historianservername>/historian-rest-api/v1/serverproperties
SAMPLE QUERY PARAM GET URL 
https://<historianservername>/historian-rest-api/v1/serverproperties
SAMPLE RESPONSE 
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": {

        "Storages": [

            {

                "StorageName": "System Storage",

                "StorageType": 2,

                "NumberOfDataStores": 1,

                "NumberOfArchivers": 0,

                "DataStores": [

                    "System"

                ],

                "Id": "861C2743-72E0-46FC-9B31-90E28CC39B8D",

                "IsDefault": false,

                "LastModifiedUser": null,

                "LastModifiedTime": "1970-01-01T00:00:00.000Z",

                "ArchiverServices": []

            },

            {

                "StorageName": "xyz",

                "StorageType": 0,

                "NumberOfDataStores": 3,

                "NumberOfArchivers": 1,

                "DataStores": [

                    "ScadaBuffer",

                    "DHSSystem",

                    "User"

                ],

                "Id": "5F267DF3-879A-4222-8A0E-D31EDEA83C14",

                "IsDefault": true,

                "LastModifiedUser": null,

                "LastModifiedTime": "1970-01-01T00:00:00.000Z",

                "ArchiverServices": [

                    {

                        "LogicalName": "DataArchiver_xyz",

                        "NodeName": "xyz",

                        "ServiceType": 2,

                        "IsAlreadyAdded": true,

                        "TCPPort": 14001

                    }

                ]

            }

        ],

        "Servers": [

            {

                "LogicalName": "DataArchiver_xyz0",

                "NodeName": "xyz",

                "ServiceType": 2,

                "Status": 1,

                "TCPPort": 14001,

                "MemoryVMSize": "4778",

                "TotalFailedWrites": "0",

                "WriteCacheHitRatio": "0.748",

                "TotalOutOfOrder": "3",

                "CompressionRatio": "0.321",

                "ReadQueueSize": "0",

                "WriteQueueSize": "0",

                "MsgQueueSize": "0",

                "ReadQueueProcessingRate": "1",

                "WriteQueueProcessingRate": "31",

                "MsgQueueProcessingRate": "0"

            }

        ]

    }

}
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN>” 
https://<historianservername>/historian-rest-api/v1/serverproperties

Response Parameters

Parameter Data Type Required? Description
ErrorCode Integer Yes For example, ErrorCode = 0 implies the operation was successful.
ErrorMessage String Yes For example, NULL.