8 Dashboard
8.1 Get
GET https://<HOST>:<PORT>/api/dashboard/get?version=0
Returns the status information from the dashboard.
Required Permissions
-
API
-
Monitoring Mode Read Access
Request parameters
-
dateFormat
Determines the format of dates. Default is XZWO.
Type: String
Possible Values:
-
ISO-8601
-
XZWO
-
-
list
Restricts the returned status information to the selected category, if provided.
Type: String
Possible Values:
-
sipNodes
-
sfbUcmaNodes
-
ldapConnections
-
certificates
-
conditions
-
networkControllers
-
ldapDirectories
-
numberValidationRouteSupervision
-
azureActiveDirectories
-
restClientRouteSupervision
-
directoryRouteSupervision
-
certificateIssuance
-
Example
GET http://127.0.0.1:8110/api/dashboard/get?version=0
HTTP Response Body
{
"numberValidationRouteSupervision": [],
"sfbUcmaNodes": [],
"sipNodes": [{
"sessions": {
"incomingCalls": 0,
"outgoingCalls": 0
},
"optionsPackets": {
"received": {
"success": 0,
"failed": 0
},
"sent": {
"success": 0,
"failed": 31945
}
},
"displayName": "XCAPI (localhost)",
"sipSrvEnabled": false,
"remoteSipDomain": "sip:localhost:5062",
"sipTransportState": "sipTransportStateUp",
"registrarsConfigured": 0,
"ipAddress": "127.0.0.1",
"operational": false,
"portRanges": {
"udp": {
"lastPort": 13000,
"firstPort": 10000
},
"tcp": {
"lastPort": 13000,
"firstPort": 10000
}
},
"enabled": true,
"networkState": "UP",
"natTraversalEnabled": false,
"maxRegisteredClients": 0,
"localPorts": {
"udp": {
"port": 5060,
"enabled": true
},
"tcp": {
"port": 5060,
"enabled": true
},
"tls": {
"port": 5061,
"enabled": true
}
}
}],
"certificates": [],
"ldapConnections": [{
"hostname": "dc1.wob.te-systems.de",
"encryption": "startTls",
"establishTime": "UTC 2023-07-19 10:03:29",
"port": 389,
"cachedItems": 1,
"displayName": "dc1.wob.te-systems.de",
"searchCount": 0,
"state": "connected",
"username": "bunzeck@te-systems.de"
}],
"ldapDirectories": [{
"successfullSearches": 0,
"failedSearches": 0,
"displayName": "LDAP Directory",
"ldapConnection": "dc1.wob.te-systems.de",
"state": "connectionUp",
"lastSearch": "success"
}],
"directoryRouteSupervisions": [],
"networkControllers": [{
"address": "127.0.0.1",
"systemName": "Software Loopback Interface 1",
"displayName": "XCAPI (localhost)",
"state": "active",
"speed": "1 GBit/s"
}],
"azureActiveDirectories": [],
"conditions": [
{
"eventIdTrue": 2002,
"eventIdFalse": 2003,
"displayName": "Maintenance Mode Inactive",
"userDefined": false,
"state": true
},
{
"eventIdTrue": 2000,
"eventIdFalse": 2001,
"displayName": "Maintenance Mode Active",
"userDefined": false,
"state": false
}
],
"restClientRouteSupervision": []
}