E-mail
WAS THIS PAGE HELPFUL? Leave Feedback
3.0 APPENDIX C JSON Example Data
- 3.1 Host JSON
- 3.2 Host Group JSON
- 3.3 Services JSON
- 3.4 Devices JSON
- 3.5 Events JSON
- 3.6 Statistics - JSON
- 3.7 Categories JSON
- 3.8 Property Types JSON
- 3.9 Application Types JSON
- 3.10 Entity Types JSON
- 3.11 Consolidation JSON
- 3.12 Notifications JSON
- 3.13 Perf Data JSON
- 3.14 Audit Log JSON
- 3.15 Host Identity JSON
- 3.16 Host Blacklist JSON
- 3.17 Biz Downtime JSON
- 3.18 Device Template Profile JSON
- 3.19 Custom Groups JSON
- 3.20 Service Groups JSON
- 3.21 Biz Service Authorization JSON
- 3.22 Suggestions JSON
- 3.23 License Check JSON
- 3.24 Biz Feeder JSON
3.1 Host JSON
3.1.1 Host - Response Data - Shallow JSON
{
"id": 1, "hostName": "localhost", "description": "localhost",
"monitorStatus": "UP", "appType": "NAGIOS",
"deviceIdentification": "127.0.0.1", "deviceDisplayName": null,
"lastCheckTime": 1369241096000,
"bubbleUpStatus": "UP", "serviceAvailability": "9.52",
"acknowledged": false,
"properties": {
"LastPluginOutput": "OK - 127.0.0.1: rta 0.039ms, lost 0%",
"Comments": " ",
"MaxAttempts": "10",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"isEventHandlersEnabled": "true",
"PerformanceData": "rta=0.039ms;3000.000;5000.000;0; pl=0%;80;100;",
"PercentStateChange": "0",
"isPassiveChecksEnabled": "true",
"isChecksEnabled": "true",
"Latency": "31",
"CactiRRDCommand": "Load Average;",
"isNotificationsEnabled": "false",
"Alias": "Linux Server #1",
"isAcknowledged": "false",
"ScheduledDowntimeDepth": "0",
"LastStateChange": "May 17, 2013",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "6"
}
}
3.1.2 Host - Response Data - Deep JSON
{ "id": 1, "hostName": "localhost", "description": "localhost", "monitorStatus": "UP",
"appType": "NAGIOS", "deviceIdentification": "127.0.0.1",
"lastCheckTime": 1369241096000, "bubbleUpStatus": "UP",
"serviceAvailability": "9.52", "acknowledged": false,
"device": {
"deviceId": 1,
"displayName": "127.0.0.1",
"identification": "127.0.0.1",
"description": "Device localhost"
}, "hostStatus": {
"hostStatusId": 1,
"hostMonitorStatus": {
"monitorStatusId": 1,
"name": "UP",
"description": "UP"
},
"lastCheckTime": 1369241096000,
"checkType": {
"checkTypeId": 1,
"name": "ACTIVE",
"description": "Active Check"
},
"nextCheckTime": 1369241406000,
"stateType": {
"stateTypeId": 2,
"name": "HARD",
"description": "State Hard"
}
},
"properties": {
"LastPluginOutput": "OK - 127.0.0.1: rta 0.039ms, lost 0%",
"Comments": " ",
"MaxAttempts": "10",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"isEventHandlersEnabled": "true",
"PerformanceData": "rta=0.039ms;3000.000;5000.000;0; pl=0%;8",
"PercentStateChange": "0",
"isPassiveChecksEnabled": "true",
"isChecksEnabled": "true",
"Latency": "31",
"CactiRRDCommand": "Load Average;",
"isNotificationsEnabled": "false",
"Alias": "Linux Server #1",
"isAcknowledged": "false",
"ScheduledDowntimeDepth": "0",
"LastStateChange": "May 17, 2013",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "6"
},
"serviceStatuses": [
{
"serviceStatusId": 16,
"serviceDescription": "local_process_gw_listener",
"lastCheckTime": 1369241007000,
"nextCheckTime": 1369241607000,
"lastStateChange": 1368802286000,
"monitorStatus": "UNSCHEDULED CRITICAL",
"domain": null,
"metricType": null,
"applicationType": "NAGIOS",
"checkType": "ACTIVE",
"stateType": "HARD",
"lastPlugInOutput": "3^^^3^^^0^^^"
},{
"serviceStatusId": 12,
"serviceDescription": "local_mem_nagios",
"lastCheckTime": 1369240744000,
"nextCheckTime": 1369241344000,
"lastStateChange": 1368802143000,
"monitorStatus": "OK",
"domain": null,
"metricType": null,
"applicationType": "NAGIOS",
"checkType": "ACTIVE",
"stateType": "HARD",
"lastPlugInOutput": "1^^^3^^^0^^^"
}
],
"serviceCount": 21,
"hostGroups": [
{
"name": "IT",
"description": null,
"alias": "it",
"appType": "NAGIOS"
},{
"name": "Linux Servers",
"description": " ",
"alias": "Linux Servers",
"appType": "NAGIOS"
}
],
"applicationType": {
"applicationTypeId": 100,
"name": "NAGIOS",
"description": "System monitored by Nagios",
"stateTransitionCriteria": "Device;Host;ServiceDescription",
"stateTransitionFieldList": null
}
}
3.1.3 Host Query - Response Data - Simple JSON
{ "hosts" : [
{
"id": 6,
"hostName": "172.28.113.151",
"description": "172.28.113.151",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.151",
"deviceDisplayName": null,
"lastCheckTime": 1369240986000,
"bubbleUpStatus": "UP",
"serviceAvailability": "50",
"acknowledged": false
},
{
"id": 12,
"hostName": "172.28.113.168",
"description": "172.28.113.168",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.168",
"deviceDisplayName": null,
"lastCheckTime": 1369240996000,
"bubbleUpStatus": "UP",
"serviceAvailability": "0",
"acknowledged": false
},{
"id": 14,
"hostName": "demo",
"description": "demo",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.155",
"deviceDisplayName": null,
"lastCheckTime": 1369241016000,
"bubbleUpStatus": "UP",
"serviceAvailability": "11.11",
"acknowledged": false
}
]
3.1.4 Host Query - Response Data - Sync JSON
{
"hosts" : [ {
"properties" : {
},
"hostName" : "localhost",
"appType" : "NAGIOS",
"deviceIdentification" : "127.0.0.1",
"services" : [ {
"properties" : {
},
"appType" : "NAGIOS",
"description" : "local_process_gw_listener"
}, {
"properties" : {
},
"appType" : "NAGIOS",
"description" : "local_nagios_latency"
}, {
"properties" : {
},
"appType" : "NAGIOS",
"description" : "local_mem_java"
} ]
} ]
}
3.1.5 Host Post - Post Data JSON
{ "hosts":
[
{
"hostName": "host-100", "description": "local_cpu",
"monitorStatus": "UP", "appType": "NAGIOS",
"deviceIdentification" :"192.168.5.50", "monitorServer": "localhost",
"deviceDisplayName": "Device-50",
"properties" : {
"Latency": "125",
"UpdatedBy":"admin",
"Comments": "Testing"
}
},
{
"hostName": "host-101", "description": "tcp_http",
"monitorStatus": "UP", "appType": "NAGIOS",
"deviceIdentification" :"192.168.5.51", "monitorServer": "localhost",
"deviceDisplayName": "Device-51",
"properties" : {
"TimeUp": "100",
"TimeDown": "200",
"TimeOK": "300"
}
}
]
}
3.1.6 Host Delete - Delete Data JSON
[
{ "hostName": "host-100" },{ "hostName": "host-101" }
]
From 7.1 release onward, use this format (not valid in 7.0):
{ "hostGroups" : [
{ "hostName": "host-100" },{ "hostName": "host-101" }
]
}}
3.1.7 Host Autocomplete - Response Data JSON
{
"names" : [ "localhost", "localhost2" ]
}
3.2 Host Group JSON
3.2.1 HostGroup - Response Data - Shallow JSON
{"id": 5, "name": "Support", "alias": "support", "appType": "NAGIOS",
"hosts": [
{
"id": 17,
"hostName": "mc-cent5-64-a",
"description": "mc-cent5-64-a",
"monitorStatus": "UNSCHEDULED DOWN",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.170",
"lastCheckTime": 1369241056000,
"bubbleUpStatus": "UNSCHEDULED DOWN",
"serviceAvailability": "100",
"acknowledged": false,
"serviceCount": 1
},{
"id": 6,
"hostName": "172.28.113.151",
"description": "172.28.113.151",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.151",
"lastCheckTime": 1369240986000,
"bubbleUpStatus": "UP",
"serviceAvailability": "50",
"acknowledged": false,
"serviceCount": 4
}
]}
3.2.2 HostGroup - Response Data - Deep JSON
{ "hostGroups" : [
{
"id": 6,
"name": "Eng-QA",
"alias": "engqa",
"appType": "NAGIOS",
"hosts": [
{
"id": 19,
"hostName": "malbec",
"description": "malbec",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.169",
"lastCheckTime": 1369241106000,
"bubbleUpStatus": "UP",
"serviceAvailability": "0",
"acknowledged": false,
"serviceCount": 3,
"properties": {
"LastPluginOutput": "OK - 172.28.113.169: rta 0.763ms, lost 0%",
"Comments": " ",
"MaxAttempts": "3",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"PerformanceData": "rta=0.763ms;3000.000;5000.000;0; pl=0%;80;100;; rtmax=0.763ms;;;; rtmin=0.763ms;;;;",
"isEventHandlersEnabled": "true",
"PercentStateChange": "0",
"isPassiveChecksEnabled": "true",
"isChecksEnabled": "true",
"Latency": "64",
"isNotificationsEnabled": "false",
"Alias": "malbec.groundwork.groundworkopensource.com",
"isAcknowledged": "false",
"ScheduledDowntimeDepth": "0",
"LastStateChange": "May 18, 2013",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "4"
}
},
{
"id": 2,
"hostName": "qa-load-xp-1",
"description": "qa-load-xp-1",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "172.28.113.166",
"lastCheckTime": 1369240856000,
"bubbleUpStatus": "UP",
"serviceAvailability": "0",
"acknowledged": false,
"serviceCount": 3,
"properties": {
"LastPluginOutput": "OK - 172.28.113.166: rta 4.102ms, lost 0%",
"Comments": " ",
"MaxAttempts": "3",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"PerformanceData": "rta=4.102ms;3000.000;5000.000;0; pl=0%;80;100;; rtmax=4.102ms;;;; rtmin=4.102ms;;;;",
"isEventHandlersEnabled": "true",
"PercentStateChange": "0",
"isPassiveChecksEnabled": "true",
"isChecksEnabled": "true",
"Latency": "423",
"isNotificationsEnabled": "false",
"Alias": "qa-load-xp-1.groundwork.groundworkopensource.com",
"isAcknowledged": "false",
"ScheduledDowntimeDepth": "0",
"LastStateChange": "May 17, 2013",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "11"
}
}
],
"applicationType": {
"applicationTypeId": 100,
"name": "NAGIOS",
"description": "System monitored by Nagios",
"stateTransitionCriteria": "Device;Host;ServiceDescription"
},
"statistics": [
{
"name": "CRITICAL",
"count": 0
},
{
"name": "WARNING",
"count": 0
},
{
"name": "UNKNOWN",
"count": 0
},
{
"name": "OK",
"count": 12
},
{
"name": "PENDING",
"count": 0
},
{
"name": "SCHEDULED CRITICAL",
"count": 0
},{
"name": "UNSCHEDULED CRITICAL",
"count": 1
}
]
}
]
}
3.2.3 HostGroup Post - Post Data JSON
{ "hostGroups" : [
{
"name": "blueGroup", "description": "My Blues Group", "alias": "blue",
"hosts" : [{ "hostName" : "localhost" }
]
},
{
"name": "redGroup", "description": "My Red Group", "alias": "red",
"hosts" : [
{ "hostName" : "demo" },{ "hostName" : "localhost" }
]
}
]
}
3.2.4 HostGroup Delete - Delete Data JSON
{ "hostGroups" : [
{ "name": "blueGroup" },{ "name": "blueGroup" }
]
}
3.2.5 Host Group Autocomplete - Response Data JSON
{
"names" : [ "HG1", "HG2" ]
}
3.3 Services JSON
3.3.1 Services - Response Data - JSON
{ "id": 1, "appType": "NAGIOS", "description": "local_cpu_httpd",
"monitorStatus": "OK", "lastCheckTime": 1369241086000,
"nextCheckTime": 1369241686000, "lastStateChange": 1369241086000,
"hostName": "localhost", "metricType": null, "domain": null,
"stateType": "HARD", "checkType": "ACTIVE", "lastHardState": "PENDING",
"properties": {
"LastPluginOutput": "OK - total %CPU for process httpd : 0.0",
"Comments": " ",
"MaxAttempts": "3",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"RRDPath": "/usr/local/groundwork/rrd/localhost_local_cpu_httpd.rrd",
"isEventHandlersEnabled": "true",
"PerformanceData": "%CPU=0.0;40;50",
"PercentStateChange": "0",
"isAcceptPassiveChecks": "true",
"RRDCommand": "rrdtool graph - DEF:a=\"/usr/local/groundwork/rrd/",
"isProblemAcknowledged": "false",
"isChecksEnabled": "true",
"Latency": "998",
"RemoteRRDCommand": " ",
"isNotificationsEnabled": "false",
"ScheduledDowntimeDepth": "0",
"RRDLabel": "CPU Utilization",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "187"
}
}
3.3.2 Services Query - Response Data - JSON
{ "services" : [
{
"id": 67,
"appType": "NAGIOS",
"description": "http_alive",
"monitorStatus": "OK",
"lastCheckTime": 1369240607000,
"nextCheckTime": 1369241207000,
"lastStateChange": 1369240607000,
"hostName": "malbec",
"metricType": null,
"domain": null,
"stateType": "HARD",
"checkType": "ACTIVE",
"lastHardState": "PENDING",
"properties": {
"LastPluginOutput": "HTTP OK: HTTP/1.1 200 OK - 1269 bytes in 0.002 second",
"Comments": " ",
"MaxAttempts": "3",
"CurrentNotificationNumber": "0",
"isFlapDetectionEnabled": "false",
"RRDPath": "/usr/local/groundwork/rrd/malbec_http_alive.rrd",
"PerformanceData": "time=0.002119s;4.000000;7.000000;0.000000 size=1269B;;;0",
"isEventHandlersEnabled": "true",
"PercentStateChange": "0",
"isAcceptPassiveChecks": "true",
"RRDCommand": "rrdtool graph - --imgformat=PNG ",
"isChecksEnabled": "true",
"isProblemAcknowledged": "false",
"Latency": "950",
"RemoteRRDCommand": " ",
"isNotificationsEnabled": "false",
"ScheduledDowntimeDepth": "0",
"RRDLabel": "Response Time",
"CurrentAttempt": "1",
"LastNotificationTime": "0",
"ExecutionTime": "7"
}
},{
"id": 62,
"appType": "NAGIOS",
"description": "http_alive",
"monitorStatus": "OK",
"lastCheckTime": 1369240584000,
"nextCheckTime": 1369241184000,
"lastStateChange": 1369240584000,
"hostName": "qa-sles-11-64-2",
"metricType": null,
"domain": null,
"stateType": "HARD",
"checkType": "ACTIVE",
"lastHardState": "PENDING"
}
]
}
3.3.3 Services Post - Post Data JSON
{
"services" : [
{
"hostName": "localhost", "monitorServer": "localhost",
"deviceIdentification" :"127.0.0.1",
"description": "service-109", "appType": "NAGIOS", "monitorStatus": "OK",
"lastCheckTime": "2013-05-22T09:36:47-07:00",
"nextCheckTime": "2013-05-22T09:46:47-07:00",
"lastStateChange": "2013-05-22T09:36:47-07:00",
"stateType": "HARD", "checkType": "ACTIVE", "lastHardState": "PENDING",
"properties": {
"LastPluginOutput": "HTTP OK: HTTP/1.1 200 OK",
"MaxAttempts": "3",
"Latency": "950",
"ExecutionTime": "7"
}
},
{
"hostName": "localhost", "monitorServer": "localhost",
"deviceIdentification" :"127.0.0.1",
"description": "service-110", "appType": "NAGIOS", "monitorStatus": "OK",
"lastCheckTime": "2013-05-22T09:36:47-07:00",
"nextCheckTime": "2013-05-22T09:46:47-07:00",
"lastStateChange": "2013-05-22T09:36:47-07:00",
"stateType": "HARD", "checkType": "ACTIVE", "lastHardState": "PENDING",
"properties": {
"LastPluginOutput": "HTTPS OK: HTTPS/1.1 200 OK",
"MaxAttempts": "1",
"Latency": "100",
"ExecutionTime": "30"
}
}
]
}
3.3.4 Services Delete - Delete Data JSON
{
"services" : [
{
"hostName": "localhost", "description": "service-109"
},{
"hostName": "localhost", "description": "service-110"
}
]
}
3.3.5 Service Autocomplete - Response Data JSON
{
"names" : [ "local_cpu_httpd", "local_cpu_java" ]
}
3.4 Devices JSON
3.4.1 Devices - Response Data - Shallow JSON
{"id": 1,
"identification": "127.0.0.1",
"displayName": "127.0.0.1",
"description": "Device localhost"
}
3.4.2 Devices - Response Data - Deep JSON
{ "id": 1, "identification": "127.0.0.1",
"displayName": "127.0.0.1",
"description": "Device localhost",
"hosts": [
{
"id": 1,
"hostName": "localhost",
"description": "localhost",
"monitorStatus": "UP",
"appType": "NAGIOS",
"deviceIdentification": "127.0.0.1",
"lastCheckTime": 1369241096000,
"bubbleUpStatus": "UP",
"serviceAvailability": "9.52",
"acknowledged": false,
"serviceCount": 21
}],
"monitorServers": [
{
"monitorServerId": 1,
"monitorServerName": "localhost",
"ip": "127.0.0.1",
"description": "Default Monitor Server"
}]
}
3.4.3 Devices Query - Response Data - Shallow JSON
{ "devices": [
{
"id": 1,
"displayName": "127.0.0.1",
"identification": "127.0.0.1",
"description": "Device localhost"
},
{
"id": 16,
"displayName": "qa-sles-11-64-2",
"identification": "172.28.113.150"
},
{
"id": 6,
"displayName": "172.28.113.151",
"identification": "172.28.113.151"
},{
"id": 5,
"displayName": "do-win7-1",
"identification": "172.28.113.152"
}
]
}
3.4.4 Devices Post - Post Data JSON
{ "devices" : [
{
"displayName": "device-900", "identification": "172.28.128.100",
"hosts" : [
{ "abc.com" : "Host ABC" },{ "def.com" : "Host DEF"}
],
"monitorServers" : [{
"monitorServerName" : "ms1",
"ip" : "182.80.100.212"
}
]
}
]
}
3.4.5 Devices Remove - Remove Data JSON
{ "devices" : [{ "identification": "172.28.128.100" }
]
3.5 Events JSON
3.5.1 Events Query - Response Data - JSON
{ "events" : [
{
"id": 5,
"device": "127.0.0.1",
"host": "localhost",
"service": "local_cpu_perl",
"operationStatus": "ACCEPTED",
"monitorStatus": "OK",
"severity": "OK",
"applicationSeverity": "OK",
"component": "OK",
"priority": "Lowest Priority in a scale from 1-10",
"typeRule": "UNDEFINED",
"textMessage": "OK - total %CPU for process perl : 4.1",
"firstInsertDate": 1368801972000,
"lastInsertDate": 1368801972000,
"reportDate": 1368801994057,
"msgCount": 1,
"appType": "NAGIOS",
"properties": [
{
"name": "ErrorType",
"value": "SERVICE ALERT"
},{
"name": "SubComponent",
"value": "localhost:local_cpu_perl"
}
]
},
{
"id": 4,
"device": "127.0.0.1",
"host": "localhost",
"service": "local_cpu_nagios",
"operationStatus": "ACCEPTED",
"monitorStatus": "OK",
"severity": "OK",
"applicationSeverity": "OK",
"component": "OK",
"priority": "Lowest Priority in a scale from 1-10",
"typeRule": "UNDEFINED",
"textMessage": "OK - total %CPU for process nagios : 0.0",
"firstInsertDate": 1368801943000,
"lastInsertDate": 1368801943000,
"reportDate": 1368801963951,
"msgCount": 1,
"appType": "NAGIOS",
"properties": [
{
"name": "ErrorType",
"value": "SERVICE ALERT"
},{
"name": "SubComponent",
"value": "localhost:local_cpu_nagios"
}
]
}
]
}
3.5.2. Events Post - Post Data JSON
{ "events": [
{
"host": "localhost",
"monitorServer": "localhost",
"service": "local_load",
"appType": "NAGIOS",
"textMessage": "This is a serious Nagios Message on Device 127.0.0.1",
"monitorStatus": "UP",
"severity": "SERIOUS",
"consolidationName": "NAGIOSEVENT",
"device": "127.0.0.1",
"reportDate": "2013-06-02T10:55:32.943",
"properties": {
"Comments": "Additional comments",
"Latency": "125.0"
}
}
]
}
3.5.3 Events Properties Update - Put Data JSON
{
"events" : [
{
"id" : "4809",
"properties" : {
"Latency" : "126.31",
"UpdatedBy" : "UnitTesterABC",
"Comments" : "This is a test 11."
}
},
{
"id" : "4810",
"properties" : {
"Latency" : "127.31",
"UpdatedBy" : "UnitTesterAB",
"Comments" : "This is a test 22."
}
}
]
}
3.6 Statistics - JSON
- Total Host Statistics
{ "totalHosts": 20, "totalServices": 131, "name": "_ALL_", "availability": 75.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 15 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 5 } ]} - Total Services Statistics
{ "totalHosts": 20, "totalServices": 131, "name": "_ALL_", "availability": 0.0, "properties": [ { "name": "CRITICAL", "count": 0 }, { "name": "WARNING", "count": 2 }, { "name": "UNKNOWN", "count": 0 }, { "name": "OK", "count": 114 }, { "name": "PENDING", "count": 0 }, { "name": "SCHEDULED CRITICAL", "count": 0 },{ "name": "UNSCHEDULED CRITICAL", "count": 15 } ]} - Host Statistics for two hosts, grouped by host
{ "totalHosts": 2, "totalServices": 0, "name": "'localhost','support-xp-1'", "availability": 0.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 1 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 1 } ]} - Host Statistics group by Host Group
{ "statistics" : [ { "totalHosts": 2, "totalServices": 23, "name": "IT", "availability": 100.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 2 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 0 } ] }, { "totalHosts": 1, "totalServices": 4, "name": "HG1", "availability": 100.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 1 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 0 } ] }, { "totalHosts": 5, "totalServices": 75, "name": "Engineering", "availability": 60.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 3 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 2 } ] }, { "totalHosts": 10, "totalServices": 55, "name": "Linux Servers", "availability": 100.0, "bubbleUpStatus": null, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 10 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 0 } ] }, { "totalHosts": 4, "totalServices": 12, "name": "Support", "availability": 75.0, "properties": [ { "name": "DOWN", "count": 0 }, { "name": "UNREACHABLE", "count": 0 }, { "name": "PENDING", "count": 0 }, { "name": "UP", "count": 3 }, { "name": "SCHEDULED DOWN", "count": 0 },{ "name": "UNSCHEDULED DOWN", "count": 1 } ] } ] } - Service statistics grouped by host groups
{ "statistics" : [ { "totalHosts": 2, "totalServices": 23, "name": "IT", "availability": 86.0, "properties": [ { "name": "CRITICAL", "count": 0 }, { "name": "WARNING", "count": 0 }, { "name": "UNKNOWN", "count": 0 }, { "name": "OK", "count": 20 }, { "name": "PENDING", "count": 0 }, { "name": "SCHEDULED CRITICAL", "count": 0 },{ "name": "UNSCHEDULED CRITICAL", "count": 3 } ] }, { "totalHosts": 1, "totalServices": 4, "name": "HG1", "availability": 50.0, "properties": [ { "name": "CRITICAL", "count": 0 }, { "name": "WARNING", "count": 0 }, { "name": "UNKNOWN", "count": 0 }, { "name": "OK", "count": 2 }, { "name": "PENDING", "count": 0 }, { "name": "SCHEDULED CRITICAL", "count": 0 },{ "name": "UNSCHEDULED CRITICAL", "count": 2 } ] } ] } - Service statistics grouped by a service groups
{ "statistics" : [ { "totalHosts": 0, "totalServices": 8, "name": "web-svr", "availability": 75.0, "bubbleUpStatus": null, "properties": [ { "name": "CRITICAL", "count": 0 }, { "name": "WARNING", "count": 0 }, { "name": "UNKNOWN", "count": 0 }, { "name": "OK", "count": 6 }, { "name": "PENDING", "count": 0 }, { "name": "SCHEDULED CRITICAL", "count": 0 },{ "name": "UNSCHEDULED CRITICAL", "count": 2 } ] }, { "totalHosts": 0, "totalServices": 2, "name": "SG1", "availability": 100.0, "properties": [ { "name": "CRITICAL", "count": 0 }, { "name": "WARNING", "count": 0 }, { "name": "UNKNOWN", "count": 0 }, { "name": "OK", "count": 2 }, { "name": "PENDING", "count": 0 }, { "name": "SCHEDULED CRITICAL", "count": 0 },{ "name": "UNSCHEDULED CRITICAL", "count": 0 } ] } ] } - Host availability for a host group named HG1
{"availability": 100.0, "queryBy": "hosts", "queryParam": "hostGroup", "queryValue": "HG1"} - Service availability for a host group named HG1
{"availability": 50.0, "queryBy": "services", "queryParam": "hostGroup", "queryValue": "HG1"} - Service availability for a service group named SG1
{"availability": 100.0, "queryBy": "services", "queryParam": "serviceGroup", "queryValue": "SG1"}
3.7 Categories JSON
3.7.1 Categories - Response Data - Shallow JSON
{
"id" : 63,
"name" : "TEST-2",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true
}
3.7.2 Categories - Response Data - Deep JSON
{
"id" : 63,
"name" : "TEST-2",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true,
"applicationType" : {
"properties" : {
}
},
"entityType" : {
"id" : 23,
"name" : "SERVICE_GROUP",
"description" : "com.groundwork.collage.model.impl.ServiceGroup",
"applicationTypeSupported" : false,
"logicalEntity" : true
},
"children" : [ {
"id" : 65,
"name" : "TEST-B",
"entityTypeName" : "SERVICE_GROUP",
"parentNames" : [ "TEST-A", "TEST-2" ],
"root" : false
} ]
}
3.7.3 Categories - Response Data - Full JSON
{
"id" : 63,
"name" : "TEST-2",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true,
"applicationType" : {
"properties" : {
}
},
"entityType" : {
"id" : 23,
"name" : "SERVICE_GROUP",
"description" : "com.groundwork.collage.model.impl.ServiceGroup",
"applicationTypeSupported" : false,
"logicalEntity" : true
},
"children" : [ {
"id" : 65,
"name" : "TEST-B",
"entityTypeName" : "SERVICE_GROUP",
"parentNames" : [ "TEST-2", "TEST-A" ],
"root" : false,
"applicationType" : {
"properties" : {
}
},
"entityType" : {
"id" : 23,
"name" : "SERVICE_GROUP",
"description" : "com.groundwork.collage.model.impl.ServiceGroup",
"applicationTypeSupported" : false,
"logicalEntity" : true
},
"parents" : [ {
"id" : 63,
"name" : "TEST-2",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true
}, {
"id" : 64,
"name" : "TEST-A",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true
} ],
"entities" : [ {
"id" : 31,
"objectID" : 1024,
"entityTypeId" : 2,
"entityTypeName" : "SERVICE_STATUS"
} ]
} ]
}
3.7.4 Categories Query - Response Data - Shallow JSON
{
"categories" : [ {
"id" : 62,
"name" : "TEST-1",
"entityTypeName" : "SERVICE_GROUP",
"root" : true
}, {
"id" : 63,
"name" : "TEST-2",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true
}, {
"id" : 64,
"name" : "TEST-A",
"entityTypeName" : "SERVICE_GROUP",
"childNames" : [ "TEST-B" ],
"root" : true
}, {
"id" : 65,
"name" : "TEST-B",
"entityTypeName" : "SERVICE_GROUP",
"parentNames" : [ "TEST-A", "TEST-2" ],
"root" : false
} ]
}
3.7.5 Categories Post - Post Data JSON
{
"categories": [
"name" : "TEST-A",
"entityTypeName" : "SERVICE_GROUP",
}, {
"name" : "TEST-B",
"entityTypeName" : "SERVICE_GROUP",
"entities" : [ {
"objectID" : 1024,
"entityTypeName" : "SERVICE_STATUS"
} ]
} ]
}
3.7.6 Categories Put - Post Data JSON
{
"categoryUpdates": [ {
"entityTypeName" : "SERVICE_GROUP",
"categoryName" : "TEST-A",
"create" : "AS_ROOT"
}, {
"entityTypeName" : "SERVICE_GROUP",
"categoryName" : "TEST-B",
"create" : "AS_CHILD",
"parentName" : "TEST-A"
}, {
"entityTypeName" : "SERVICE_GROUP",
"categoryName" : "TEST-B",
"modify" : "ADD_CHILD",
"otherCategoryNames" : [ "TEST-2" ]
} ]
}
3.8 Property Types JSON
3.8.1 Property Types Query Response Data JSON
Lookup by name:
{
"id" : 40,
"name" : "AcknowledgeComment",
"description" : "",
"dataType" : "STRING"
}
Query:
{
"propertyTypes" : [{
"id" : 37,
"name" : "30DayMovingAvg",
"description" : "",
"dataType" : "DOUBLE"
}, {
"id" : 40,
"name" : "AcknowledgeComment",
"description" : "",
"dataType" : "STRING"
}
]}
3.8.2 Property Types Post Data JSON
{
"propertyTypes" : [{
"name" : "unusedCPU",
"description" : "Measures unused CPU usage",
"dataType" : "DOUBLE"
}, {
"name" : "virtualName",
"description" : "Name of virtual appliance",
"dataType" : "STRING"
}
]
}
3.9 Application Types JSON
3.9.1 Application Types Query Response Data JSON
Lookup by name:
{
"id" : 200,
"name" : "VEMA",
"description" : "Virtual Environment Monitor Agent",
"stateTransitionCriteria" : "Device;Host;ServiceDescription"
}
Query:
{
"applicationTypes" :
[
{
"id" : 104,
"name" : "ARCHIVE",
"description" : "Archiving related messages",
"stateTransitionCriteria" : "Device;Host"
},
{
"id" : 105,
"name" : "BSM",
"description" : "Business Service Monitoring",
"stateTransitionCriteria" : "Device;Host"
},{
"id" : 103,
"name" : "CHRHEV",
"description" : "Cloud Hub for Red Hat Virtualization",
"stateTransitionCriteria" : "Device;Host;ServiceDescription"
}
]
}
3.9.2 Application Types Post Data JSON
{ "applicationTypes":
[
{
"name" : "NEWONE",
"description" : "Virtual Environment Monitor Agent",
"stateTransitionCriteria" : "Device;Host;ServiceDescription",
"entityProperties" : [{
"propertyType" : "isAcknowledged",
"entityType" : "HOST_STATUS",
"sortOrder" : 82
}, {
"propertyType" : "LastPluginOutput",
"entityType" : "HOST_STATUS",
"sortOrder" : 80
}, {
"propertyType" : "LastPluginOutput",
"entityType" : "SERVICE_STATUS",
"sortOrder" : 81
}, {
"propertyType" : "PerformanceData",
"entityType" : "SERVICE_STATUS",
"sortOrder" : 83
} ]
}
]}
3.10 Entity Types JSON
3.10.1 Entity Types Query Response Data JSON
Lookup by name:
{
"id" : 5,
"name" : "HOST",
"description" : "com.groundwork.collage.model.impl.Host",
"applicationTypeSupported" : false,
"logicalEntity" : false
}
Query:
{
"entityTypes" : [{
"id" : 7,
"name" : "APPLICATION_TYPE",
"description" : "com.groundwork.collage.model.impl.ApplicationType",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 8,
"name" : "CATEGORY",
"description" : "com.groundwork.collage.model.impl.Category",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 9,
"name" : "CHECK_TYPE",
"description" : "com.groundwork.collage.model.impl.CheckType",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 10,
"name" : "COMPONENT",
"description" : "com.groundwork.collage.model.impl.Component",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 4,
"name" : "DEVICE",
"description" : "com.groundwork.collage.model.impl.Device",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 5,
"name" : "HOST",
"description" : "com.groundwork.collage.model.impl.Host",
"applicationTypeSupported" : false,
"logicalEntity" : false
}, {
"id" : 6,
"name" : "HOSTGROUP",
"description" : "com.groundwork.collage.model.impl.HostGroup",
"applicationTypeSupported" : false,
"logicalEntity" : false
}]}
3.11 Consolidation JSON
3.11.1 Consolidation Query Response Data JSON
Lookup by name:
{
"id" : 4,
"name" : "SYSLOG",
"criteria" : "OperationStatus;Device;MonitorStatus;ipaddress;ErrorType;SubComponent"
}
Query:
{
"consolidations" : [{
"consolidationId" : 2,
"name" : "NAGIOSEVENT",
"criteria" : "Device;MonitorStatus;OperationStatus;SubComponent;ErrorType"
}, {
"consolidationId" : 3,
"name" : "SNMPTRAP",
"criteria" : "OperationStatus;Device;ipaddress;MonitorStatus;Event_OID_numeric;Event_Name;Category;Variable_Bindings"
}, {
"consolidationId" : 4,
"name" : "SYSLOG",
"criteria" : "OperationStatus;Device;MonitorStatus;ipaddress;ErrorType;SubComponent"
}, {
"consolidationId" : 1,
"name" : "SYSTEM",
"criteria" : "OperationStatus;Device;MonitorStatus;ApplicationType;TextMessage"
} ]
}
3.11.2 Consolidation Criteria POST Data JSON
{ "consolidations":
[
{
"name" : "VEMA",
"criteria": "MonitorStatus;ApplicationType"
},
{
"name" : "BMS",
"criteria": "Device;ApplicationType"
}
]}
3.12 Notifications JSON
3.12.1 Host Notification POST Data JSON
{
"notifications" : [
{
"hostName" : "server-12",
"hostAddress" : "10.0.0.11",
"hostGroupNames" : "group-21,group-22",
"hostNotificationId" : "331",
"hostOutput" : "Hypervisor cannot be reached to determine the status",
"hostState" : "UP",
"notificationComment" : "Cloud Hub Host Notification",
"notificationRecipients" : "admin@gwos.com",
"notificationType" : "RECOVERY",
"checkDateTime" : "2014-04-14 12:39:33",
"notificationAuthOrAlias" : "alias"
},{
"hostName" : "server-13",
"hostAddress" : "10.0.0.12",
"hostGroupNames" : "group-21,group-22",
"hostNotificationId" : "453",
"hostOutput" : "Application Server is rebooting",
"hostState" : "PENDING",
"notificationComment" : "Java Agent Host Notification",
"notificationRecipients" : "admin@gwos.com",
"notificationType" : "PROBLEM",
"checkDateTime" : "2014-04-14 12:39:33",
"notificationAuthOrAlias" : "alias"
}
]
}
3.12.2 Service Notification POST Data JSON
{
"notifications" : [
{
"hostName" : "server-12",
"serviceDescription" : "local_cpu_nagios",
"hostAddress" : "10.0.0.11",
"hostGroupNames" : "group-21,group-22",
"hostAlias" : "host1",
"serviceGroupNames" : "sg1,sg2",
"serviceOutput" : "Service cannot be reached to determine the status",
"serviceState" : "UNKNOWN",
"serviceNotificationId" : "433",
"notificationComment" : "Cloud Hub Host Notification",
"notificationRecipients" : "admin@gwos.com",
"notificationType" : "RECOVERY",
"checkDateTime" : "2014-04-14 07:21:33",
"notificationAuthOrAlias" : "alias"
},{
"hostName" : "server-13",
"serviceDescription" : "vm.cpu_util",
"hostAddress" : "10.0.0.12",
"hostGroupNames" : "group-21,group-22",
"hostAlias" : "host2",
"serviceGroupNames" : "sg3,sg4",
"serviceOutput" : "Service cannot be reached to determine the status",
"serviceState" : "UNKNOWN",
"serviceNotificationId" : "433",
"notificationComment" : "Cloud Hub Host Notification",
"notificationRecipients" : "admin@gwos.com",
"notificationType" : "RECOVERY",
"checkDateTime" : "2014-04-14 07:21:33",
"notificationAuthOrAlias" : "alias"
}
]
}
3.13 Perf Data JSON
3.13.1 Perf Data POST Data JSON
{
"perfDataList" : [
{
"appType" : "OS",
"label" : "CPU Utilized",
"serverName" : "localhost",
"serverTime" : 1397512737,
"serviceName" : "vm.cpu_util",
"value" : "65",
"critical" : "95",
"warning" : "85"
},{
"appType" : "OS",
"label" : "Memory Usage",
"serverName" : "localhost",
"serverTime" : 1397512737,
"serviceName" : "host.free_ram_mb",
"value" : "200",
"critical" : "400",
"warning" : "300",
"tagNames" : [ "test" ],
"tagValues" : [ "value" ],
"cpuTag" : "0",
"typeTag" : "core"
}
]
}
3.13.2 Performance Time Series JSON Data
{
"appType" : "VEMA",
"serverName" : "loadtest-vm-0",
"serviceName" : "loadtest-vm-metric-0",
"startTime" : 1443208066000,
"endTime" : 1443208366000,
"interval" : 30000,
"perfDataTimeSeriesValues" : [ {
"valueType" : "value",
"timestamp" : 1443208110000,
"value" : 36.0
}, {
"valueType" : "value",
"timestamp" : 1443208170000,
"value" : 27.0
}, {
"valueType" : "value",
"timestamp" : 1443208230000,
"value" : 20.0
}, {
"valueType" : "value",
"timestamp" : 1443208290000,
"value" : 13.0
}, {
"valueType" : "thold-c",
"timestamp" : 1443208110000,
"value" : 100.0
}, {
"valueType" : "thold-c",
"timestamp" : 1443208170000,
"value" : 100.0
}, {
"valueType" : "thold-c",
"timestamp" : 1443208230000,
"value" : 100.0
}, {
"valueType" : "thold-c",
"timestamp" : 1443208290000,
"value" : 100.0
}, {
"valueType" : "thold-w",
"timestamp" : 1443208110000,
"value" : 90.0
}, {
"valueType" : "thold-w",
"timestamp" : 1443208170000,
"value" : 90.0
}, {
"valueType" : "thold-w",
"timestamp" : 1443208230000,
"value" : 90.0
}, {
"valueType" : "thold-w",
"timestamp" : 1443208290000,
"value" : 90.0
} ]
}
3.14 Audit Log JSON
3.14.1 Audit Log - Response Data - JSON
{
"auditLogs": [ {
"auditLogId" : 33,
"subsystem" : "SV",
"hostName" : "server_2",
"action" : "DELETE",
"description" : "Test deletion server 2.",
"username" : "admin",
"timestamp" : "2014-09-26T14:03:25.600-0600",
"serviceDescription" : "network_users"
}, {
"auditLogId" : 32,
"subsystem" : "SV",
"hostName" : "server_2",
"action" : "ADD",
"description" : "Test addition server 2.",
"username" : "admin",
"timestamp" : "2014-09-26T14:03:25.600-0600",
"serviceDescription" : "local_processes"
} ]
}
3.15 Host Identity JSON
3.15.1 Host Identity - Response Data - JSON
{
"hostIdentityId" : "8fb9a880-f093-4892-a0f3-b1a403b49e5e",
"hostName" : "test-host-name-2",
"hostNames" : [ "test-host-name-2", "9e1b25a0-e036-4ce1-bf01-56c9cc8934ce" ],
"host" : false
}
{
"hostIdentities" : [ {
"hostIdentityId" : "1267adf2-6437-11e4-82be-002219ed08d3",
"hostName" : "test-host-name-0",
"hostNames" : [ "test-host-name-0" ],
"host" : false
}, {
"hostIdentityId" : "12c545e8-6437-11e4-82bf-002219ed08d3",
"hostName" : "test-host-name-1",
"hostNames" : [ "test-host-name-1", "test-host-name-1.0", "test-host-name-1.1" ],
"host" : false
}, {
"hostIdentityId" : "8fb9a880-f093-4892-a0f3-b1a403b49e5e",
"hostName" : "test-host-name-2",
"hostNames" : [ "9e1b25a0-e036-4ce1-bf01-56c9cc8934ce", "test-host-name-2" ],
"host" : false
} ]
}
3.15.2 Host Identity Autocomplete - Response Data - JSON
{
"names" : [ "localhost", "localhost2" ]
}
3.16 Host Blacklist JSON
3.16.1 Host Blacklist - Response Data - JSON
{
"hostBlacklistId" : 14,
"hostName" : "test-host-name-2"
}
{
"hostBlacklists" : [ {
"hostBlacklistId" : 12,
"hostName" : "test-host-name-0"
}, {
"hostBlacklistId" : 13,
"hostName" : "test-host-name-1"
}, {
"hostBlacklistId" : 14,
"hostName" : "test-host-name-2"
} ]
}
3.17 Biz Downtime JSON
3.17.1 Biz downtime - Request Data - JSON
{
"hostNames" : [ "host0", "host1" ],
"serviceDescriptions" : [ "*" ]
}
{
"serviceDescriptions" : [ "*" ],
"serviceGroupCategoryNames" : [ "HTTP Services", "Email Services" ]
}
{
"hostNames" : [ "*" ],
"serviceDescriptions" : [ "*" ],
"hostGroupNames" : [ "Linux Servers" ]
}
3.17.2 Biz downtime - Response Data - JSON
{
"bizHostServiceInDowntimes" : [ {
"hostName" : "host0",
"serviceDescription" : "local_memory",
"scheduledDowntimeDepth" : 1,
"entityType" : "HOSTGROUP",
"entityName" : "Linux Servers"
}, {
"hostName" : "host1",
"serviceDescription" : "local_memory",
"scheduledDowntimeDepth" : 1,
"entityType" : "HOSTGROUP",
"entityName" : "Linux Servers"
} ]
}
3.18 Device Template Profile JSON
3.18.1 Device Template Profile - Response Data - JSON
{
"deviceTemplateProfileId" : 36,
"deviceIdentification" : "test-device-identification-2",
"deviceDescription" : "test device identification 2",
"monarchHostProfile" : "monarch-host-profile",
"timestamp" : "2014-11-26T11:01:29.056-0700"
}
{
"deviceTemplateProfiles" : [ {
"deviceTemplateProfileId" : 34,
"deviceIdentification" : "test-device-identification-0",
"deviceDescription" : "test device identification 0",
"timestamp" : "2014-11-26T11:01:29.056-0700"
}, {
"deviceTemplateProfileId" : 35,
"deviceIdentification" : "test-device-identification-1",
"deviceDescription" : "test device identification 1",
"cactiHostTemplate" : "cacti-host-template",
"timestamp" : "2014-11-26T11:01:29.056-0700"
}, {
"deviceTemplateProfileId" : 36,
"deviceIdentification" : "test-device-identification-2",
"deviceDescription" : "test device identification 2",
"monarchHostProfile" : "monarch-host-profile",
"timestamp" : "2014-11-26T11:01:29.056-0700"
} ]
}
3.19 Custom Groups JSON
3.19.1 Custom Group - Response Data
{
"id" : 11,
"name" : "TEST-CUSTOM-GROUP-0",
"description" : "TEST-CUSTOM-GROUP-0",
"appType" : "NAGIOS",
"agentId" : "TEST-AGENT",
"root" : true,
"hostGroups" : [ {
"id" : 4,
"name" : "TEST-HOST-GROUP-0",
"alias" : "TEST-HOST-GROUP-0",
"appType" : "NAGIOS"
} ]
}
3.19.2 Custom Groups Query - Response Data
{
"customGroups" : [ {
"id" : 11,
"name" : "TEST-CUSTOM-GROUP-0",
"description" : "TEST-CUSTOM-GROUP-0",
"appType" : "NAGIOS",
"agentId" : "TEST-AGENT",
"root" : true,
"hostGroups" : [ {
"id" : 4,
"name" : "TEST-HOST-GROUP-0",
"alias" : "TEST-HOST-GROUP-0",
"appType" : "NAGIOS"
} ]
}, {
"id" : 12,
"name" : "TEST-CUSTOM-GROUP-1",
"agentId" : "TEST-AGENT",
"root" : true,
"serviceGroups" : [ {
"id" : 10,
"name" : "TEST-SERVICE-GROUP-0"
} ]
} ]
}
3.19.3 Custom Groups Post - Post Data
{
"customGroups" : [ {
"name" : "TEST-CUSTOM-GROUP-0",
"description" : "TEST-CUSTOM-GROUP-0",
"appType" : "NAGIOS",
"agentId" : "TEST-AGENT",
"hostGroupNames" : ["TEST-HOST-GROUP-0"]
}, {
"name" : "TEST-CUSTOM-GROUP-1",
"agentId" : "TEST-AGENT",
"serviceGroupNames" : ["TEST-SERVICE-GROUP-0"]
}, {
"name" : "TEST-CUSTOM-GROUP-2",
"appType" : "NAGIOS"
}, {
"name" : "TEST-CUSTOM-GROUP-3"
} ]
}
3.19.4 Custom Group Put - Post Data
{
"name" : "TEST-CUSTOM-GROUP-0",
"hostGroupNames" : ["TEST-HOST-GROUP-1"]
}
3.19.5 Custom Group Autocomplete - Response Data
{
"names" : [ "CG1", "CG2" ]
}
3.20 Service Groups JSON
3.20.1 Service Group - Response Data, (service properties elided here for the sake of brevity)
{
"id" : 29,
"name" : "SG-200",
"description" : "Service Group 200",
"appType" : "VEMA",
"appTypeDisplayName" : "VEMA",
"agentId" : "Agent-007",
"services" : [ {
"properties" : {
},
"id" : 2,
"appType" : "NAGIOS",
"description" : "local_cpu_java",
"monitorStatus" : "OK",
"lastCheckTime" : "2013-05-22T10:37:15.000-0600",
"nextCheckTime" : "2013-05-22T10:47:15.000-0600",
"lastStateChange" : "2013-05-17T08:57:15.000-0600",
"hostName" : "localhost",
"stateType" : "HARD",
"checkType" : "ACTIVE",
"lastHardState" : "PENDING",
"monitorServer" : "localhost",
"deviceIdentification" : "127.0.0.1",
"lastPlugInOutput" : "1^^^3^^^0^^^05/17/2013 08:57:15 AM^^^OK - total %CPU for process java : 2.8^^^%CPU=2.8;40;50"
}, {
"properties" : {
},
"id" : 4,
"appType" : "NAGIOS",
"description" : "local_cpu_perl",
"monitorStatus" : "OK",
"lastCheckTime" : "2013-05-22T10:36:13.000-0600",
"nextCheckTime" : "2013-05-22T10:46:13.000-0600",
"lastStateChange" : "2013-05-17T08:46:12.000-0600",
"hostName" : "localhost",
"stateType" : "HARD",
"checkType" : "ACTIVE",
"lastHardState" : "PENDING",
"monitorServer" : "localhost",
"deviceIdentification" : "127.0.0.1",
"lastPlugInOutput" : "1^^^3^^^0^^^05/17/2013 08:46:12 AM^^^OK - total %CPU for process perl : 0.7^^^%CPU=0.7;40;50"
} ]
}
3.20.2 Service Groups Query - Response Data, (service properties elided here for the sake of brevity)
{
"serviceGroups" : [ {
"id" : 29,
"name" : "SG-200",
"description" : "Service Group 200",
"appType" : "VEMA",
"appTypeDisplayName" : "VEMA",
"agentId" : "Agent-007",
"services" : [ {
"properties" : {
},
"id" : 2,
"appType" : "NAGIOS",
"description" : "local_cpu_java",
"monitorStatus" : "OK",
"lastCheckTime" : "2013-05-22T10:37:15.000-0600",
"nextCheckTime" : "2013-05-22T10:47:15.000-0600",
"lastStateChange" : "2013-05-17T08:57:15.000-0600",
"hostName" : "localhost",
"stateType" : "HARD",
"checkType" : "ACTIVE",
"lastHardState" : "PENDING",
"monitorServer" : "localhost",
"deviceIdentification" : "127.0.0.1",
"lastPlugInOutput" : "1^^^3^^^0^^^05/17/2013 08:57:15 AM^^^OK - total %CPU for process java : 2.8^^^%CPU=2.8;40;50"
}, {
"properties" : {
},
"id" : 4,
"appType" : "NAGIOS",
"description" : "local_cpu_perl",
"monitorStatus" : "OK",
"lastCheckTime" : "2013-05-22T10:36:13.000-0600",
"nextCheckTime" : "2013-05-22T10:46:13.000-0600",
"lastStateChange" : "2013-05-17T08:46:12.000-0600",
"hostName" : "localhost",
"stateType" : "HARD",
"checkType" : "ACTIVE",
"lastHardState" : "PENDING",
"monitorServer" : "localhost",
"deviceIdentification" : "127.0.0.1",
"lastPlugInOutput" : "1^^^3^^^0^^^05/17/2013 08:46:12 AM^^^OK - total %CPU for process perl : 0.7^^^%CPU=0.7;40;50"
} ]
} ]
}
3.20.3 Service Groups Post - Post Data
{
"serviceGroups" : [ {
"name" : "SG-200",
"description" : "Service Group 200",
"appType" : "VEMA",
"agentId" : "Agent-007",
"services" : [ {
"service" : "local_cpu_java",
"host" : "localhost"
}, {
"service" : "local_cpu_perl",
"host" : "localhost"
} ]
} ]
}
3.20.4 Service Group Put - Post Data
{
"name" : "SG-200",
"services" : [{
"service" : "local_load",
"host" : "localhost"
}, {
"service" : "local_users",
"host" : "localhost"
} ]
}
3.20.5 Service Group Autocomplete - Response Data
{
"names" : [ "SG1", "SG2" ]
}
3.21 Biz Service Authorization JSON
3.21.1 Biz Service Authorization - Request Data - JSON
{
"hostGroupNames" : ["Linux Servers"],
"serviceGroupNames" : ["local"]
}
3.21.2 Biz Service Authorization - Response Data - JSON
{
"hostNames" : [ "localhost" ],
"serviceHostNames" : {
"local_cpu_httpd" : [ "localhost" ],
"local_cpu_java" : [ "localhost" ],
"local_cpu_syslog-ng" : [ "localhost" ],
"local_swap" : [ "localhost" ],
"local_process_nagios" : [ "localhost" ],
"tcp_http" : [ "localhost" ]
}
}
3.22 Suggestions JSON
3.22.1 Suggestions - Query Response Data - JSON
{
"count" : 18,
"suggestions" : [ {
"name" : "local_cpu_httpd",
"entityType" : "SERVICE"
}, {
"name" : "local_cpu_java",
"entityType" : "SERVICE"
}, {
"name" : "local_cpu_nagios",
"entityType" : "SERVICE"
} ]
}
3.22.2 Suggestions - Names Response Data - JSON
{
"names" : [ "localhost" ]
}
3.23 License Check JSON
3.23.1 License Check - Check Response Data - JSON
{
"success" : true,
"message" : "OK to allocate 0 devices",
"devicesRequested" : 0,
"devices" : 1
}
3.24 Biz Feeder JSON
3.24.1 Biz Create or Update Hosts - Hosts Request Data - JSON
{
"hosts" : [ {
"properties" : {
},
"host" : "host6",
"status" : "UP",
"message" : "UP",
"hostGroup" : "hosts",
"device" : "10.0.0.6",
"appType" : "NAGIOS",
"agentId" : "a4ca80e0-e855-43ee-86d8-f4e499f0a824",
"checkIntervalMinutes" : 5,
"allowInserts" : true,
"mergeHosts" : true,
"setStatusOnCreate" : true,
"services" : [ {
"properties" : {
},
"host" : "host6",
"service" : "local_cpu_httpd",
"status" : "OK",
"message" : "OK - 10",
"serviceGroup" : "cpu",
"hostGroup" : "hosts",
"device" : "10.0.0.6",
"appType" : "NAGIOS",
"agentId" : "a4ca80e0-e855-43ee-86d8-f4e499f0a824",
"serviceValue" : "10",
"metricType" : "vm",
"warningLevel" : 50,
"criticalLevel" : 90,
"checkIntervalMinutes" : 5,
"allowInserts" : true,
"mergeHosts" : true,
"setStatusOnCreate" : true
}, {
"properties" : {
},
"host" : "host6",
"service" : "local_cpu_java",
"status" : "OK",
"message" : "OK - 20",
"serviceGroup" : "cpu",
"hostGroup" : "hosts",
"device" : "10.0.0.6",
"appType" : "NAGIOS",
"agentId" : "a4ca80e0-e855-43ee-86d8-f4e499f0a824",
"serviceValue" : "20",
"metricType" : "vm",
"warningLevel" : 75,
"criticalLevel" : 90,
"checkIntervalMinutes" : 5,
"allowInserts" : true,
"mergeHosts" : true,
"setStatusOnCreate" : true
} ]
} ]
}
3.24.2 Biz Create or Update Hosts - Results Data - JSON
{
"successful" : 3,
"failed" : 0,
"entityType" : "Host",
"operation" : "Update",
"warning" : 0,
"results" : [ {
"entity" : "host6",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/hosts/host6",
"message" : "Update"
}, {
"entity" : "host6:local_cpu_httpd",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/services/local_cpu_httpd%3FhostName=host6",
"message" : "Update"
}, {
"entity" : "host6:local_cpu_java",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/services/local_cpu_java%3FhostName=host6",
"message" : "Update"
} ],
"count" : 3
}
3.24.3 Biz Create or Update Services - Services Request Data - JSON
{
"services" : [ {
"properties" : {
},
"host" : "host6",
"service" : "local_cpu_httpd",
"status" : "PENDING",
"message" : "PENDING - new",
"serviceGroup" : "cpu",
"hostGroup" : "hosts",
"device" : "10.0.0.6",
"appType" : "NAGIOS",
"agentId" : "a4ca80e0-e855-43ee-86d8-f4e499f0a824",
"warningLevel" : -1,
"criticalLevel" : -1,
"checkIntervalMinutes" : 5,
"allowInserts" : true,
"mergeHosts" : true,
"setStatusOnCreate" : false
}, {
"properties" : {
},
"host" : "host6",
"service" : "local_cpu_java",
"status" : "PENDING",
"message" : "PENDING - new",
"serviceGroup" : "cpu",
"hostGroup" : "hosts",
"device" : "10.0.0.6",
"appType" : "NAGIOS",
"agentId" : "a4ca80e0-e855-43ee-86d8-f4e499f0a824",
"warningLevel" : -1,
"criticalLevel" : -1,
"checkIntervalMinutes" : 5,
"allowInserts" : true,
"mergeHosts" : true,
"setStatusOnCreate" : false
} ]
}
3.24.4 Biz Create or Update Services - Results Data - JSON
{
"successful" : 3,
"failed" : 0,
"entityType" : "ServiceStatus",
"operation" : "Update",
"warning" : 0,
"results" : [ {
"entity" : "host6",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/hosts/host6",
"message" : "Insert"
}, {
"entity" : "host6:local_cpu_httpd",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/services/local_cpu_httpd%3FhostName=host6",
"message" : "Insert"
}, {
"entity" : "host6:local_cpu_java",
"status" : "success",
"location" : "http://localhost:8080/foundation-webapp/api/services/local_cpu_java%3FhostName=host6",
"message" : "Insert"
} ],
"count" : 3
}