REST APIs : Available operations and endpoints : Apex endpoints
  
Apex endpoints
 
Page Contents
/about
/admDiscoveries
/adms
/alarms
/backupfiles
/bayeux
/businessGroups
/certificates
/dashboardResults
/dashboards
/failover
/gigastors
/logs
/observers
/operations
/printDashboardResults
/scheduledReports
/session
/settings/backuprestore
/settings/baselineSchedule
/settings/failover
/settings/logs
/settings/managebyoms
/settings/notifications
/settings/oalicense
/settings/oasettings
/softwareserver
/softwareupgrade
/status
/thresholds
/transferredTimes
/users
/widgetResults
/widgets
This list shows the methods and endpoints available for Apex. Using them you can accomplish nearly any task you can imagine to control or configure Apex.
Base URI: https://hostname/oa/api/
Note: A secure HTTP session is required. Therefore, all requests must be sent to https://. Sending a request to http:// will fail.
For example, if you want to retrieve a list of users from Apex you would use an HTTP GET method. The GET request would be sent to https://hostname/oa/api/users/.
REST sometimes is referred to as using QCRUD, where each letter stands for a different action that can be taken: Query, Create, Read, Update, Delete. The REST API is comprised of these HTTP actions:
GET: used to query for or read data from the server, like user IDs or dashboard results. GET is considered a “safe” method because no changes on the server are made.
POST: used to create new objects, like users, users, or dashboards. For a POST method, the HTTP response contains the URI path and {ID} of the newly created resource in the “Location” HTTP header. For example, when a new user is created, the “Location” HTTP header will contain: "/users/9D24469A-976E-11E4-B88F-002590365523".
PUT: used to update an existing object. All PUT methods must always take the full resource definition, not just fields being modified. A PUT request is considered Idempotent or “unsafe” because it can change an existing object. This is not to imply that PUT actions should not be done. Not at all. Instead, it means simply that you must ensure that the definition you send has exactly the values you want it to have before issuing the PUT.
DELETE: used to delete an object. A DELETE is also considered Idempotent. After an object has been deleted with the DELETE method, it cannot be restored. There is no confirmation requested like there is in the web interface. Use with care!
All time values are specified in UTC using the ISO8601 time format: "2015-10-24T04:06:16Z". The Z at the end of the format indicates that there is no time offset from UTC. UTC does not observe summer time (daylight savings time). It is also possible that UTC may be several hours different from your local time. The web UI client uses its local browser time, but all API requests use UTC.
{ID} denote a variable ID value in the endpoint where ID is a UUID of the form "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX". For example, /users/9D24469A-976E-11E4-B88F-002590365523.
If the word optional is not listed for a parameter, the parameter is required. Some strings are enumerated lists, and the string must be one of the listed items.
/about
 
GET /about Retrieve the application version
Result Model      JSON Example
about
productShort ( string  [Max length: 64] )
productLong ( string  [Max length: 128] )
version ( VersionObject )
major ( integer [signed 32-bit] )
minor ( integer [signed 32-bit] )
build ( integer [signed 32-bit] )
patch ( integer [signed 32-bit] )
architecture ( string  [Max length: 16] )
copyright ( string  [Max length: 128] )
license ( string  [Max length: 128] )
serverTimeZoneMinutesOffsetFromUTC ( integer [signed 32-bit] ) : Offset, in minutes, that the server time zone is from UTC. E.g., for CST (-06:00), this value is -360
buildDesc ( string  [Max length: 128] )
JSON Example

{
"data": {
"about": {
"productShort": "Observer Apex",
"productLong": "Viavi Solutionsâ„¢ Observer Apex",
"version": {
"major": 17,
"minor": 1,
"build": 0,
"patch": 0
},
"architecture": "64-bit",
"copyright": "© 2016 Viavi Solutions Inc.",
"serverTimeZoneMinutesOffsetFromUTC": -300,
"buildDesc": "master/93ee9f14"
}
},
"status": {
"code": 200,
"message": "OK"
}
}
 
/admDiscoveries
Created: 2016-03-24   Revised: 2018-03-27
 
POST /admDiscoveries Create a result set for a client/server ADM discovery
Parameters Model
params
admId ( uuid )
dashboardId ( uuid ) : The ID of the dashboard associated with this ADM
businessGroupId ( uuid ) : The ID of the business group associated with this ADM
instanceId ( uuid ) : The ID of the instance associated with this ADM
sourceNodeIpString ( string ) : IP Address of the selected node, if any. Required for CLIENT_DISCOVERY, CLIENT_ROLLUP_DISCOVERY, and SERVER_CONNECTION_DISCOVERY; Required NOT to be present for SERVER_NODE_DISCOVERY
filterIpRangeStringStart ( string ) : Start of IP range, or specific IP address if not specifying a range
filterIpRangeStringEnd ( string ) : End of IP range; can be omitted if filtering on a single IP rather than a range
filterAppNames ( filterAppNamesObject  [Max: 16] )
appName ( string )
discoveryType ( string )
NONE : No Discovery; used as an initializer
CLIENT_CONNECTION : Client Connection ADM Discovery mode of operation
CLIENT_ROLLUP : Client Connection Rollup ADM Discovery mode of operation
SERVER_NODE : Server Node ADM Discovery mode of operation
SERVER_CONNECTION : Server Connection ADM Discovery mode of operation
discoveryType2 ( string ) : Secondary discovery, to support discovering both clients and servers. Set to DISCOVERY_NONE if not used
NONE : No Discovery; used as an initializer
CLIENT_CONNECTION : Client Connection ADM Discovery mode of operation
CLIENT_ROLLUP : Client Connection Rollup ADM Discovery mode of operation
SERVER_NODE : Server Node ADM Discovery mode of operation
SERVER_CONNECTION : Server Connection ADM Discovery mode of operation
params ( ExecuteParametersObject )
filter ( string )
startTime ( timestamp )
endTime ( timestamp )
Result Model
discoveryResults
admId ( uuid )
status ( DashboardExecutionStatusObject )
success ( boolean [true|false] )
errors ( array ) :
warnings ( array ) :
resultsByLevel ( resultsByLevelObject  [Max: 2] )
discoveryType ( string )
NONE : No Discovery; used as an initializer
CLIENT_CONNECTION : Client Connection ADM Discovery mode of operation
CLIENT_ROLLUP : Client Connection Rollup ADM Discovery mode of operation
SERVER_NODE : Server Node ADM Discovery mode of operation
SERVER_CONNECTION : Server Connection ADM Discovery mode of operation
discoveryDepth ( integer [signed 32-bit] )
discoveryLevelResults ( discoveryLevelResultsObject  [Max: 30000] )
ipServer ( string )
appName ( string )
ipClient ( string )
 
/adms
Created: 2016-03-24   Revised: 2018-03-27
 
POST /adms Create a new ADM
Parameters Model
adm
identification ( ADMIdentificationObject )
dashboardId ( uuid ) : The ID of the dashboard associated with this ADM
businessGroupId ( uuid ) : The ID of the business group associated with this ADM
instanceId ( uuid ) : The ID of the instance associated with this ADM
admWidgetId ( uuid ) : The ID of the widget that contains this ADM's field definitions
admId ( uuid )
displayOptions ( ADMDisplayOptionsObject )
zoomLevel ( float )
nodes ( nodesObject  [Max: 500] )
id ( uuid )
display ( ADMDisplayPropertiesObject )
type ( string )
SERVER
CLIENT
CLIENT_ROLLUP
icon ( string )
DEFAULT
CLIENT_DESKTOP
CLIENT_LAPTOP
CLIENT_ROLLUP
MONITOR
MONITOR_ROLLUP
ROUTER
SERVER
SERVER_DATABASE
SERVER_DNS
SERVER_EXCHANGE
SERVER_FILE
SERVER_FIREWALL
SERVER_MAIL
SERVER_RSS
SERVER_SQL
SERVER_VM
SERVER_WEB
TOWER
TOWER_DATABASE
TOWER_DNS
TOWER_EXCHANGE
TOWER_FILE
TOWER_FIREWALL
TOWER_MAIL
TOWER_RSS
TOWER_SQL
TOWER_VM
TOWER_WEB
label ( string  [Max length: 64] )
ipFormat ( string )
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
ip ( ip address )
dns ( string )
application ( string )
coordinates ( ADMCoordinatesObject )
x ( integer [signed 32-bit] )
y ( integer [signed 32-bit] )
connections ( connectionsObject  [Max: 5000] )
idFrom ( uuid )
idTo ( uuid )
application ( string )
etag ( etag ) : Version control tag.
GET /adms/{admID} Retrieve a specific ADM by ID
Result Model
adm
identification ( ADMIdentificationObject )
dashboardId ( uuid ) : The ID of the dashboard associated with this ADM
businessGroupId ( uuid ) : The ID of the business group associated with this ADM
instanceId ( uuid ) : The ID of the instance associated with this ADM
admWidgetId ( uuid ) : The ID of the widget that contains this ADM's field definitions
admId ( uuid )
displayOptions ( ADMDisplayOptionsObject )
zoomLevel ( float )
nodes ( nodesObject  [Max: 500] )
id ( uuid )
display ( ADMDisplayPropertiesObject )
type ( string )
SERVER
CLIENT
CLIENT_ROLLUP
icon ( string )
DEFAULT
CLIENT_DESKTOP
CLIENT_LAPTOP
CLIENT_ROLLUP
MONITOR
MONITOR_ROLLUP
ROUTER
SERVER
SERVER_DATABASE
SERVER_DNS
SERVER_EXCHANGE
SERVER_FILE
SERVER_FIREWALL
SERVER_MAIL
SERVER_RSS
SERVER_SQL
SERVER_VM
SERVER_WEB
TOWER
TOWER_DATABASE
TOWER_DNS
TOWER_EXCHANGE
TOWER_FILE
TOWER_FIREWALL
TOWER_MAIL
TOWER_RSS
TOWER_SQL
TOWER_VM
TOWER_WEB
label ( string  [Max length: 64] )
ipFormat ( string )
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
ip ( ip address )
dns ( string )
application ( string )
coordinates ( ADMCoordinatesObject )
x ( integer [signed 32-bit] )
y ( integer [signed 32-bit] )
connections ( connectionsObject  [Max: 5000] )
idFrom ( uuid )
idTo ( uuid )
application ( string )
etag ( etag ) : Version control tag.
PUT /adms/{admID} Update a specific ADM by ID
Parameters Model
adm
identification ( ADMIdentificationObject )
dashboardId ( uuid ) : The ID of the dashboard associated with this ADM
businessGroupId ( uuid ) : The ID of the business group associated with this ADM
instanceId ( uuid ) : The ID of the instance associated with this ADM
admWidgetId ( uuid ) : The ID of the widget that contains this ADM's field definitions
admId ( uuid )
displayOptions ( ADMDisplayOptionsObject )
zoomLevel ( float )
nodes ( nodesObject  [Max: 500] )
id ( uuid )
display ( ADMDisplayPropertiesObject )
type ( string )
SERVER
CLIENT
CLIENT_ROLLUP
icon ( string )
DEFAULT
CLIENT_DESKTOP
CLIENT_LAPTOP
CLIENT_ROLLUP
MONITOR
MONITOR_ROLLUP
ROUTER
SERVER
SERVER_DATABASE
SERVER_DNS
SERVER_EXCHANGE
SERVER_FILE
SERVER_FIREWALL
SERVER_MAIL
SERVER_RSS
SERVER_SQL
SERVER_VM
SERVER_WEB
TOWER
TOWER_DATABASE
TOWER_DNS
TOWER_EXCHANGE
TOWER_FILE
TOWER_FIREWALL
TOWER_MAIL
TOWER_RSS
TOWER_SQL
TOWER_VM
TOWER_WEB
label ( string  [Max length: 64] )
ipFormat ( string )
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
ip ( ip address )
dns ( string )
application ( string )
coordinates ( ADMCoordinatesObject )
x ( integer [signed 32-bit] )
y ( integer [signed 32-bit] )
connections ( connectionsObject  [Max: 5000] )
idFrom ( uuid )
idTo ( uuid )
application ( string )
etag ( etag ) : Version control tag.
DELETE /adms/{admID} Delete a specific ADM by ID
 
/alarms
Created: 2016-03-24   Revised: 2018-03-27
 
GET /alarms Retrieve all Apex Alarms available to the user
Result Model      JSON Example
alarms
alarmName ( string ) : The name assigned to the Alarm configuration
alarmId ( uuid ) : The unique ID given to this Alarm
businessGroupId ( uuid ) : The ID of the business group that will act as the source of the data
instanceId ( uuid ) : The ID of the instance that will act as the source of the data
dashboardId ( uuid ) : The ID of the dashboard to be executed
executionParameters ( AlarmExecutionParametersObject ) : Parameters detailing how frequently and for what time period to execution the Alarm Dashboard
schedule ( AlarmScheduleObject )
scheduleType ( string )
NEVER
ALWAYS
DAILY
DAY_OF_WEEK
DAY_OF_MONTH
daily ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
sunday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
monday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
tuesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
wednesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
thursday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
friday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
saturday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
dayOfMonthSchedule ( AlarmScheduleDayOfMonthObject )
monthDays ( monthDaysObject ) : One or more day-of-month schedules; duplicate days are not allowed
dayOfMonth ( integer [unsigned 32-bit] ) : The numeric day of month (1-31)
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
filter ( string )
actions ( AlarmActionsObject ) : Details about what actions to take for marginal/critical events
marginalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for marginal events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
criticalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for critical events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
etag ( etag ) : The current etag for this Alarm used to indicate if the client has the current stored version of this Alarm
JSON Example

{
"data": {
"alarms": [
{
"alarmName": "High MOS Score",
"alarmId": "A6C2BAA2-2671-11E5-85F3-F72E6EA0845C",
"businessGroupId": "CA9EC5DE-F5C3-11E4-9476-005056C00008",
"dashboardId": "D642C471-266E-11E5-85F3-F72E6EA0845C",
"executionParameters": {
"schedule": {
"scheduleType": "NEVER",
"daily": {
"disableDay": true,
"intervals": []
},
"sunday": {
"disableDay": true,
"intervals": []
},
"monday": {
"disableDay": true,
"intervals": []
},
"tuesday": {
"disableDay": true,
"intervals": []
},
"wednesday": {
"disableDay": true,
"intervals": []
},
"thursday": {
"disableDay": true,
"intervals": []
},
"friday": {
"disableDay": true,
"intervals": []
},
"saturday": {
"disableDay": true,
"intervals": []
}
}
},
"actions": {
"marginalActionParameters": {
"sendSyslog": false,
"sendSnmpTrap": false,
"sendEmail": true,
"emailAddresses": "chris@example.com"
},
"criticalActionParameters": {
"sendSyslog": false,
"sendSnmpTrap": false,
"sendEmail": true,
"emailAddresses": "pat@example.com"
}
},
"etag": "50B03FDD002FE51180E38F2C6AA4055A"
}
]
},
"status": {
"code": 200,
"message": "OK"
}
}
POST /alarms Create a new Apex Alarm
Parameters Model
alarm
alarmName ( string ) : The name assigned to the Alarm configuration
alarmId ( uuid ) : The unique ID given to this Alarm
businessGroupId ( uuid ) : The ID of the business group that will act as the source of the data
instanceId ( uuid ) : The ID of the instance that will act as the source of the data
dashboardId ( uuid ) : The ID of the dashboard to be executed
executionParameters ( AlarmExecutionParametersObject ) : Parameters detailing how frequently and for what time period to execution the Alarm Dashboard
schedule ( AlarmScheduleObject )
scheduleType ( string )
NEVER
ALWAYS
DAILY
DAY_OF_WEEK
DAY_OF_MONTH
daily ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
sunday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
monday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
tuesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
wednesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
thursday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
friday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
saturday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
dayOfMonthSchedule ( AlarmScheduleDayOfMonthObject )
monthDays ( monthDaysObject ) : One or more day-of-month schedules; duplicate days are not allowed
dayOfMonth ( integer [unsigned 32-bit] ) : The numeric day of month (1-31)
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
filter ( string )
actions ( AlarmActionsObject ) : Details about what actions to take for marginal/critical events
marginalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for marginal events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
criticalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for critical events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
etag ( etag ) : The current etag for this Alarm used to indicate if the client has the current stored version of this Alarm
GET /alarms/{alarmID} Retrieve a specific Apex Alarm by ID
Result Model
alarm
alarmName ( string ) : The name assigned to the Alarm configuration
alarmId ( uuid ) : The unique ID given to this Alarm
businessGroupId ( uuid ) : The ID of the business group that will act as the source of the data
instanceId ( uuid ) : The ID of the instance that will act as the source of the data
dashboardId ( uuid ) : The ID of the dashboard to be executed
executionParameters ( AlarmExecutionParametersObject ) : Parameters detailing how frequently and for what time period to execution the Alarm Dashboard
schedule ( AlarmScheduleObject )
scheduleType ( string )
NEVER
ALWAYS
DAILY
DAY_OF_WEEK
DAY_OF_MONTH
daily ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
sunday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
monday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
tuesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
wednesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
thursday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
friday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
saturday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
dayOfMonthSchedule ( AlarmScheduleDayOfMonthObject )
monthDays ( monthDaysObject ) : One or more day-of-month schedules; duplicate days are not allowed
dayOfMonth ( integer [unsigned 32-bit] ) : The numeric day of month (1-31)
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
filter ( string )
actions ( AlarmActionsObject ) : Details about what actions to take for marginal/critical events
marginalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for marginal events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
criticalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for critical events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
etag ( etag ) : The current etag for this Alarm used to indicate if the client has the current stored version of this Alarm
PUT /alarms/{alarmID} Update a specific Apex Alarm by ID
Parameters Model
alarm
alarmName ( string ) : The name assigned to the Alarm configuration
alarmId ( uuid ) : The unique ID given to this Alarm
businessGroupId ( uuid ) : The ID of the business group that will act as the source of the data
instanceId ( uuid ) : The ID of the instance that will act as the source of the data
dashboardId ( uuid ) : The ID of the dashboard to be executed
executionParameters ( AlarmExecutionParametersObject ) : Parameters detailing how frequently and for what time period to execution the Alarm Dashboard
schedule ( AlarmScheduleObject )
scheduleType ( string )
NEVER
ALWAYS
DAILY
DAY_OF_WEEK
DAY_OF_MONTH
daily ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
sunday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
monday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
tuesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
wednesday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
thursday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
friday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
saturday ( AlarmScheduleDayObject )
disableDay ( boolean [true|false] ) : When set to true, indicates that the configuration for this day is present but should not cause alarms to execute
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
dayOfMonthSchedule ( AlarmScheduleDayOfMonthObject )
monthDays ( monthDaysObject ) : One or more day-of-month schedules; duplicate days are not allowed
dayOfMonth ( integer [unsigned 32-bit] ) : The numeric day of month (1-31)
intervals ( intervalsObject )
executionFrequency ( string )
1MINUTE
10MINUTES
1HOUR
4HOURS
12HOURS
24HOURS
executionPeriod ( string )
LAST1MINUTE
LAST10MINUTES
LAST1HOUR
LAST4HOURS
LAST12HOURS
LAST24HOURS
CUSTOM
customExecutionPeriod ( CustomExecutionPeriodObject ) : Custom analysis period, only allowed if executionPeriod is CUSTOM_PERIOD
fromDaysBack ( integer [unsigned 32-bit] )
fromHourOfDay ( integer [unsigned 8-bit] )
toDaysBack ( integer [unsigned 32-bit] )
toHourOfDay ( integer [unsigned 8-bit] )
startTimeHour ( integer [unsigned 8-bit] )
startTimeMinute ( integer [unsigned 8-bit] )
endTimeHour ( integer [unsigned 8-bit] )
endTimeMinute ( integer [unsigned 8-bit] )
filter ( string )
actions ( AlarmActionsObject ) : Details about what actions to take for marginal/critical events
marginalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for marginal events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
criticalActionParameters ( AlarmActionParametersObject ) : Parameters detailing what action to take for critical events
sendSyslog ( boolean [true|false] ) : When set to true, indicates a Syslog message should be sent when the event triggers
sendSnmpTrap ( boolean [true|false] ) : When set to true, indicates an SNMP trap should fire when the event triggers
sendEmail ( boolean [true|false] ) : When set to true, indicates an email should be sent to the provided list of addresses when the event triggers
emailAddresses ( string ) : Specifies the list of emails that should be alerted to the event triggering
etag ( etag ) : The current etag for this Alarm used to indicate if the client has the current stored version of this Alarm
DELETE /alarms/{alarmID} Delete a specific Apex Alarm by ID
 
/backupfiles
Created: 2016-03-24   Revised: 2018-03-27
 
GET /backupfiles Retrieve all backup files
Result Model      JSON Example
files
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
JSON Example

{
"data": {
"files": [
{
"id": "0D58A6B6-B40E-3355-B0B2-B6AB676C5EA1",
"probeId": 3935521621,
"backupTime": "2016-03-14T06:01:00Z",
"flags": {
"backup_command": false,
"restore_command": false,
"system_files": false,
"report_files": false,
"log_files": false,
"protocol_files": false
},
"etag": "469C3218A5EFE51198C3005056C00008"
}
]
},
"status": {
"code": 200,
"message": "OK"
}
}
POST /backupfiles Create a new backup file
Parameters Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
GET /backupfiles/{fileID} Retrieve a specific backup file by ID
Result Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
PUT /backupfiles/{fileID} Update a specific backup file by ID
Parameters Model
backup
id ( uuid )
probeId ( integer [unsigned 32-bit] )
backupTime ( timestamp )
flags ( flagsObject )
backup_command (true|false).
restore_command (true|false).
system_files (true|false).
report_files (true|false).
log_files (true|false).
protocol_files (true|false).
etag ( etag )
DELETE /backupfiles/{fileID} Delete a specific backup file by ID
 
/bayeux
Created: 2016-03-24   Revised: 2018-03-27
 
POST /bayeux Implements the Bayeux Protocol
Parameters Model
messages
 
/businessGroups
Created: 2016-03-24   Revised: 2018-03-27
 
GET /businessGroups Retrieve all business groups
Result Model
businessgroups
id ( uuid ) : The unique ID of the business group
name ( string ) : The display name of the business group.
description ( string ) : An optional longer description of the business group.
flags ( flagsObject )
enabled (true|false). Whether or not trending is enabled for this business group
visible (true|false). Whether or not to show the business group to the users. (e.g. You might want to hide this if it's part of another group)
thresholdCfgId ( uuid ) : The optional threshold configuration for this business group
filter ( string ) : The business group level filter
etag ( etag ) : The version tag for the business group
sources ( sourcesObject  [Max: 1024] ) : The set of sources that belong to this business group
sourceId ( uuid ) : The ID of the business group source
probeId ( uuid ) : The ID of the probe
instanceId ( uuid ) : The ID of the probe instance
flowId ( uuid ) : The ID of the NetFlow data source
children ( childrenObject  [Max: 32] ) : The set of sources that belong to this business group
childId ( uuid ) : The ID of the referenced child element
filters ( filtersObject  [Max: 1024] ) : The set of filters that apply to instances in this business group
instanceId ( uuid ) : The ID of the instance to apply the filter to
filter ( string ) : The filter to apply to the instance
POST /businessGroups Create a new business group
Parameters Model
businessgroup
id ( uuid ) : The unique ID of the business group
name ( string ) : The display name of the business group.
description ( string ) : An optional longer description of the business group.
flags ( flagsObject )
enabled (true|false). Whether or not trending is enabled for this business group
visible (true|false). Whether or not to show the business group to the users. (e.g. You might want to hide this if it's part of another group)
thresholdCfgId ( uuid ) : The optional threshold configuration for this business group
filter ( string ) : The business group level filter
etag ( etag ) : The version tag for the business group
sources ( sourcesObject  [Max: 1024] ) : The set of sources that belong to this business group
sourceId ( uuid ) : The ID of the business group source
probeId ( uuid ) : The ID of the probe
instanceId ( uuid ) : The ID of the probe instance
flowId ( uuid ) : The ID of the NetFlow data source
children ( childrenObject  [Max: 32] ) : The set of sources that belong to this business group
childId ( uuid ) : The ID of the referenced child element
filters ( filtersObject  [Max: 1024] ) : The set of filters that apply to instances in this business group
instanceId ( uuid ) : The ID of the instance to apply the filter to
filter ( string ) : The filter to apply to the instance
GET /businessGroups/{businessGroupID} Retrieve a specific business group by ID
Result Model
businessgroup
id ( uuid ) : The unique ID of the business group
name ( string ) : The display name of the business group.
description ( string ) : An optional longer description of the business group.
flags ( flagsObject )
enabled (true|false). Whether or not trending is enabled for this business group
visible (true|false). Whether or not to show the business group to the users. (e.g. You might want to hide this if it's part of another group)
thresholdCfgId ( uuid ) : The optional threshold configuration for this business group
filter ( string ) : The business group level filter
etag ( etag ) : The version tag for the business group
sources ( sourcesObject  [Max: 1024] ) : The set of sources that belong to this business group
sourceId ( uuid ) : The ID of the business group source
probeId ( uuid ) : The ID of the probe
instanceId ( uuid ) : The ID of the probe instance
flowId ( uuid ) : The ID of the NetFlow data source
children ( childrenObject  [Max: 32] ) : The set of sources that belong to this business group
childId ( uuid ) : The ID of the referenced child element
filters ( filtersObject  [Max: 1024] ) : The set of filters that apply to instances in this business group
instanceId ( uuid ) : The ID of the instance to apply the filter to
filter ( string ) : The filter to apply to the instance
PUT /businessGroups/{businessGroupID} Update a specific user business by ID
Parameters Model
businessgroup
id ( uuid ) : The unique ID of the business group
name ( string ) : The display name of the business group.
description ( string ) : An optional longer description of the business group.
flags ( flagsObject )
enabled (true|false). Whether or not trending is enabled for this business group
visible (true|false). Whether or not to show the business group to the users. (e.g. You might want to hide this if it's part of another group)
thresholdCfgId ( uuid ) : The optional threshold configuration for this business group
filter ( string ) : The business group level filter
etag ( etag ) : The version tag for the business group
sources ( sourcesObject  [Max: 1024] ) : The set of sources that belong to this business group
sourceId ( uuid ) : The ID of the business group source
probeId ( uuid ) : The ID of the probe
instanceId ( uuid ) : The ID of the probe instance
flowId ( uuid ) : The ID of the NetFlow data source
children ( childrenObject  [Max: 32] ) : The set of sources that belong to this business group
childId ( uuid ) : The ID of the referenced child element
filters ( filtersObject  [Max: 1024] ) : The set of filters that apply to instances in this business group
instanceId ( uuid ) : The ID of the instance to apply the filter to
filter ( string ) : The filter to apply to the instance
DELETE /businessGroups/{businessGroupID} Delete a specific user business by ID
GET /businessGroups/runtime/{businessGroupID} Retrieve a specific runtime business group by ID
Result Model
businessgroup
id ( uuid ) : The unique ID of the business group
sources ( sourcesObject  [Max: 1000] ) : The set of sources that belong to this business group
id ( uuid ) : The unique ID of the Observer
host ( string ) : The hostname or ip address of the Observer
flags ( flagsObject )
isObserver (true|false). Whether or not this asset is an Observer asset. (Exclusive with ORS_OBSERVER_FLAG_IS_OI)
isOI (true|false). Whether or not this asset is an Observer Infrastructure asset. (Exclusive with ORS_OBSERVER_FLAG_IS_OBSERVER)
username ( string ) : The Observer login username
password ( string ) : The Observer login password
etag ( etag ) : The version tag for the Observer
name ( string  [Max length: 64] ) : The display name of the Observer
probeId ( integer [unsigned 32-bit] ) : The Observer's probe ID
connectionState ( boolean [true|false] ) : The current connection state of the Observer
probes ( probesObject  [Max: 64] ) : The collection of probes
id ( uuid ) : The unique ID of the probe
name ( string  [Max length: 64] ) : The name of the probe
flags ( flagsObject )
isActive (true|false). Whether or not this element is active
instances ( instancesObject  [Max: 64] ) : The collection of probe instances
id ( uuid ) : The unique ID of the instance
name ( string  [Max length: 64] ) : The name of the instance
flags ( flagsObject )
isActive (true|false). Whether or not this element is active
flows ( flowsObject  [Max: 512] ) : The collection of flows for instance
id ( uuid ) : The unique ID of the flow
name ( string  [Max length: 64] ) : The name of the flow data source
flags ( flagsObject )
isActive (true|false). Whether or not this element is active
 
/certificates
Created: 2016-03-24   Revised: 2018-03-27
 
GET /certificates Retrieve all certificates in the Observer Platform certificate store
Result Model
certificates
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
GET /certificates/local Retrieve the local certificate used by current Observer Platform application
Result Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
GET /certificates/{certificateID} Retrieve a specific certificate from the Observer Platform certificate store by ID
Result Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
PUT /certificates/{certificateID} Update a specific certificate in the Observer Platform certificate store by ID
Parameters Model
certificate
id ( uuid )
assetType ( string  [Max length: 32] )
assetId ( string  [Max length: 16] )
state ( string  [Max length: 32] )
version ( integer [signed 32-bit] )
serialNumber ( integer [signed 32-bit] )
issuer ( string  [Max length: 64] )
subject ( string  [Max length: 64] )
issuingTime ( string  [Max length: 32] )
expirationTime ( string  [Max length: 32] )
signatureAlgorithm ( string  [Max length: 64] )
sha1Fingerprint ( string  [Max length: 64] )
md5Fingerprint ( string  [Max length: 64] )
assetName ( string  [Max length: 64] )
lastSeenIP ( ip address )
lastSeenTime ( string  [Max length: 32] )
DELETE /certificates/{certificateID} Delete a specific certificate by ID
 
/dashboardResults
Created: 2016-03-24   Revised: 2018-03-27
 
POST /dashboardResults Create a dashboard execution
Parameters Model
params
dashboardId ( uuid )
businessGroupId ( uuid )
instanceId ( uuid )
params ( ExecuteParametersObject )
filter ( string )
startTime ( timestamp )
endTime ( timestamp )
Result Model
results
dashboard ( DashboardObject )
id ( uuid ) : The unique ID of the dashboard
owner ( DashboardOwnershipObject ) : The ownership information for the dashboard.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
title ( string ) : The title (display name) of the dashboard.
description ( string ) : An optional longer description of the dashboard.
filter ( string ) : The optional dashboard-defined filter string.
tags ( array ) : A list of tags for organizing and linking dashboards.
hideEmptyWidgets ( boolean [true|false] ) : Hide any widgets which contain no data.
hidden ( boolean [true|false] ) : Hide this dashboard from the My Dashboards panel.
availability ( string ) : Optional field indicating the availability of this dashboard depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
workflowInfo ( DashboardWorkflowInformationObject ) : Indicates workflow functions for this dashboard.
category ( string ) : Indicates what workflow this dashboard is part of (network, application, UC, etc).
NETWORK_PERFORMANCE : Network Performance Workflow.
APPLICATION_PERFORMANCE : Application Performance Workflow.
UC_PERFORMANCE : Unified Communications(UC) Workflow.
SITE_PERFORMANCE : Site Performance Workflow.
level ( integer [signed 32-bit] ) : Indicates the workflow level this dashboard belongs to.
drilldown ( DashboardWorkflowDrilldownInfoObject ) : Indicates drilldown specific information for this dashboard as it pertains to the workflow
allowed ( boolean [true|false] ) : Indicates whether the dashboard should show drilldowns or not.
drilldownType ( string ) : Indicates what type of one click drilldown occurs. For example, drilldown to a dashboard or the trace extraction form.
DASHBOARD : Drilldown should go to a dashboard.
TRACE_EXTRACTION : Drilldown should go to trace extraction.
POPUP : Drilldowns should behave in the standard manner, showing the drilldown popup.
drilldownDashboardId ( uuid ) : Indicates what dashboard one click workflow drilldowns go to.
layout ( DashboardElementLayoutObject ) : The type of layout to use for the dashboard. Typically this will be NAMED.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : The list of elements that are direct children of the dashboard.
elementId ( uuid ) : The ID of the referenced element
elements ( elementsObject  [Max: 512] ) : The definition of all dashboard elements in the dashboard.
id ( uuid ) : The unique ID of the element.
elementType ( string ) : Whether the element is a reference to a widget, or composite of other elements. See ElementType
REFERENCE : The element directly references a widget
COMPOSITE : The element contains other elements as children
filter ( string ) : The optional element-specific filter string.
containerIndex ( integer [signed 32-bit] ) : Has different meanings for different layouts. In a named layout, this is which 'cell' the element is in.
widgetId ( uuid ) : Reference element only - The ID of the widget that this element references.
layout ( DashboardElementLayoutObject ) : Composite element only - The type of layout to use for child elements.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : Composite element only - The list of child elements by ID.
elementId ( uuid ) : The ID of the referenced element
widgets ( widgetsObject  [Max: 1024] ) : The pre-loaded definitions for all of the widgets in the dashboard. Except in the case of DASHBOARD widgets, this is populated only on read.
id ( uuid ) : The unique ID of the widget
title ( string ) : The title (display name) of the widget. Required
category ( string ) : The timeframe category of the widget. See WidgetCategory.
INTERVAL : Display data over discrete intervals for the time frame
AGGREGATE : Display summary data over the entire time frame
CURRENT : Display the current status against baseline or performance data
widgetType ( string ) : The type of widget. See WidgetType
CHART : The widget is a chart)
GRAPH : The widget is a graph
TABLE : The widget is a table
STATUS : The widget is a current status
ADM_DIAGRAM : The widget is a network diagram
DYN_ADM : The widget is a Dynamic Application Dependency Map
SITE_STATUS_MAP : The widget is a Site status map
availability ( string ) : Optional field indicating the availability of this widget depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
filter ( string ) : The optional widget-defined filter string.
maxItems ( integer [signed 32-bit] ) : The maximum number of results to return for this widget.
tags ( array ) : A set of tags for organizing the widget
owner ( DashboardOwnershipObject ) : Ownership information for the widget.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
options ( WidgetOptionsObject ) : The widget specific options. See WidgetOptions for details.
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
dynADM ( DynamicADMWidgetInfoObject ) : Information pertinent to dynamic ADM widgets
options ( DynamicADMWidgetInfoOptionsObject ) : Options for the dynamic ADM
type ( string ) : Indicates the type of dynamic ADM widget this is
DYNAMIC : Dynamic ADM Widget is saved to be dynamically discovered starting from the initial query state each time the widget is run.
startState ( DynamicADMStartStateObject ) : Indicates the starting state or 'query' of this dynamic ADM from which all results are built off of
clientIP ( ip address ) : IP address of the optional client node.
serverIP ( ip address ) : IP address of the optional server node.
application ( string ) : Application applicable to either the client or server node
fields ( fieldsObject  [Max: 64] ) : The list of widget fields
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
sortIndex ( integer [signed 32-bit] ) : The sort index for the field. This determines what order fields are sorted in. Currently 1 means sort, 0 means don't sort.
sortOrder ( string ) : When sortIndex is set, whether to sort ascending or descending.
ASCENDING : Sort the results in ascending order by this field
DESCENDING : Sort the results in descending order by this field
forceStream ( boolean [true|false] ) : Obsolete - Only valid for non-key fields. If provided and TRUE, then specify (via forcedStreamId) an override for which stream ID the field will be extracted from. When FALSE or omitted, the server automatically chooses.
forcedStreamId ( integer [signed 32-bit] ) : Obsolete - When forceStream is set, specifies the stream ID from which to extract the field data.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
children ( childrenObject  [Max: 16] ) : The collection of child fields when this is a composite field.
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
etag ( etag ) : Version control tag.
etag ( etag ) : Version control tag.
status ( DashboardExecutionStatusObject )
success ( boolean [true|false] )
errors ( array ) :
warnings ( array ) :
results ( resultsObject  [Max: 512] )
elementId ( uuid )
adm ( ADMObject )
identification ( ADMIdentificationObject )
dashboardId ( uuid ) : The ID of the dashboard associated with this ADM
businessGroupId ( uuid ) : The ID of the business group associated with this ADM
instanceId ( uuid ) : The ID of the instance associated with this ADM
admWidgetId ( uuid ) : The ID of the widget that contains this ADM's field definitions
admId ( uuid )
displayOptions ( ADMDisplayOptionsObject )
zoomLevel ( float )
nodes ( nodesObject  [Max: 500] )
id ( uuid )
display ( ADMDisplayPropertiesObject )
type ( string )
SERVER
CLIENT
CLIENT_ROLLUP
icon ( string )
DEFAULT
CLIENT_DESKTOP
CLIENT_LAPTOP
CLIENT_ROLLUP
MONITOR
MONITOR_ROLLUP
ROUTER
SERVER
SERVER_DATABASE
SERVER_DNS
SERVER_EXCHANGE
SERVER_FILE
SERVER_FIREWALL
SERVER_MAIL
SERVER_RSS
SERVER_SQL
SERVER_VM
SERVER_WEB
TOWER
TOWER_DATABASE
TOWER_DNS
TOWER_EXCHANGE
TOWER_FILE
TOWER_FIREWALL
TOWER_MAIL
TOWER_RSS
TOWER_SQL
TOWER_VM
TOWER_WEB
label ( string  [Max length: 64] )
ipFormat ( string )
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
ip ( ip address )
dns ( string )
application ( string )
coordinates ( ADMCoordinatesObject )
x ( integer [signed 32-bit] )
y ( integer [signed 32-bit] )
connections ( connectionsObject  [Max: 5000] )
idFrom ( uuid )
idTo ( uuid )
application ( string )
etag ( etag ) : Version control tag.
siteStatusMap ( SiteStatusMapObject )
query ( string ) : The type of query to render
SITE_TO_SITE : Client and Server IP Addresses aggregated by Site
SITE_VOIP_STATIONS : VoIP Station IP Addresses aggregated by Site
status ( DashboardExecutionStatusObject )
success ( boolean [true|false] )
errors ( array ) :
warnings ( array ) :
data ( ResultDataObject )
intervalData ( IntervalDataObject )
startTime ( timestamp )
endTime ( timestamp )
intervalDurationSeconds ( integer [unsigned 32-bit] )
intervals ( array ) :
series ( seriesObject  [Max: 30000] )
legend ( legendObject  [Max: 24] )
fieldId ( integer [signed 32-bit] )
data ( FieldDataObject )
status ( string )
VALID : Used to indicate the data for this field is valid.
INVALID (Default) : Used to indicate the data for this field was invalid or not found.
USE_DEFAULT : Used to indicate the data for this field should use the default value found in the FieldDataList element.
thresholdStatus ( string )
UNAVAILABLE : The status is unavailable (not enough data)
OK : The status is OK
MARGINAL : The status is marginal
CRITICAL : The status is critical
time ( timestamp )
signed ( integer [signed 64-bit] )
unsigned ( integer [unsigned 64-bit] )
float ( float )
string ( string  [Max length: 512] )
filterKey ( string )
fieldData ( fieldDataObject  [Max: 24] )
fieldId ( integer [signed 32-bit] )
attributes ( FieldAttributesObject )
tcbSummaryField ( boolean [true|false] )
defaultValue ( string  [Max length: 128] )
data ( dataObject  [Max: 180] )
status ( string )
VALID : Used to indicate the data for this field is valid.
INVALID (Default) : Used to indicate the data for this field was invalid or not found.
USE_DEFAULT : Used to indicate the data for this field should use the default value found in the FieldDataList element.
thresholdStatus ( string )
UNAVAILABLE : The status is unavailable (not enough data)
OK : The status is OK
MARGINAL : The status is marginal
CRITICAL : The status is critical
time ( timestamp )
signed ( integer [signed 64-bit] )
unsigned ( integer [unsigned 64-bit] )
float ( float )
string ( string  [Max length: 512] )
filterKey ( string )
baselineData ( baselineDataObject  [Max: 180] )
status ( string )
VALID : Used to indicate the data for this field is valid.
INVALID (Default) : Used to indicate the data for this field was invalid or not found.
USE_DEFAULT : Used to indicate the data for this field should use the default value found in the FieldDataList element.
thresholdStatus ( string )
UNAVAILABLE : The status is unavailable (not enough data)
OK : The status is OK
MARGINAL : The status is marginal
CRITICAL : The status is critical
time ( timestamp )
signed ( integer [signed 64-bit] )
unsigned ( integer [unsigned 64-bit] )
float ( float )
string ( string  [Max length: 512] )
filterKey ( string )
thresholdData ( thresholdDataObject  [Max: 4] )
thresholdName ( string )
CRITICAL_BELOW : Values below this threshold are critical
MARGINAL_BELOW : Values below this threshold are marginal
MARGINAL_ABOVE : Values above this threshold are marginal
CRITICAL_ABOVE : Values above this threshold are critical
data ( dataObject  [Max: 180] )
status ( string )
VALID : Used to indicate the data for this field is valid.
INVALID (Default) : Used to indicate the data for this field was invalid or not found.
USE_DEFAULT : Used to indicate the data for this field should use the default value found in the FieldDataList element.
thresholdStatus ( string )
UNAVAILABLE : The status is unavailable (not enough data)
OK : The status is OK
MARGINAL : The status is marginal
CRITICAL : The status is critical
time ( timestamp )
signed ( integer [signed 64-bit] )
unsigned ( integer [unsigned 64-bit] )
float ( float )
string ( string  [Max length: 512] )
filterKey ( string )
fieldGroups ( fieldGroupsObject  [Max: 64] )
type ( string )
GROUP : The field group is simply a collection of fields
COMPOSITE : The field is a composite of multiple sub-fields
parentId ( integer [signed 32-bit] )
fieldId ( array ) :
 
/dashboards
Created: 2016-03-24   Revised: 2018-03-27
 
GET /dashboards Retrieve all dashboards available to the user
Result Model
dashboards
id ( uuid ) : The unique ID of the dashboard
owner ( DashboardOwnershipObject ) : The ownership information for the dashboard.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
title ( string ) : The title (display name) of the dashboard.
description ( string ) : An optional longer description of the dashboard.
filter ( string ) : The optional dashboard-defined filter string.
tags ( array ) : A list of tags for organizing and linking dashboards.
hideEmptyWidgets ( boolean [true|false] ) : Hide any widgets which contain no data.
hidden ( boolean [true|false] ) : Hide this dashboard from the My Dashboards panel.
availability ( string ) : Optional field indicating the availability of this dashboard depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
workflowInfo ( DashboardWorkflowInformationObject ) : Indicates workflow functions for this dashboard.
category ( string ) : Indicates what workflow this dashboard is part of (network, application, UC, etc).
NETWORK_PERFORMANCE : Network Performance Workflow.
APPLICATION_PERFORMANCE : Application Performance Workflow.
UC_PERFORMANCE : Unified Communications(UC) Workflow.
SITE_PERFORMANCE : Site Performance Workflow.
level ( integer [signed 32-bit] ) : Indicates the workflow level this dashboard belongs to.
drilldown ( DashboardWorkflowDrilldownInfoObject ) : Indicates drilldown specific information for this dashboard as it pertains to the workflow
allowed ( boolean [true|false] ) : Indicates whether the dashboard should show drilldowns or not.
drilldownType ( string ) : Indicates what type of one click drilldown occurs. For example, drilldown to a dashboard or the trace extraction form.
DASHBOARD : Drilldown should go to a dashboard.
TRACE_EXTRACTION : Drilldown should go to trace extraction.
POPUP : Drilldowns should behave in the standard manner, showing the drilldown popup.
drilldownDashboardId ( uuid ) : Indicates what dashboard one click workflow drilldowns go to.
layout ( DashboardElementLayoutObject ) : The type of layout to use for the dashboard. Typically this will be NAMED.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : The list of elements that are direct children of the dashboard.
elementId ( uuid ) : The ID of the referenced element
elements ( elementsObject  [Max: 512] ) : The definition of all dashboard elements in the dashboard.
id ( uuid ) : The unique ID of the element.
elementType ( string ) : Whether the element is a reference to a widget, or composite of other elements. See ElementType
REFERENCE : The element directly references a widget
COMPOSITE : The element contains other elements as children
filter ( string ) : The optional element-specific filter string.
containerIndex ( integer [signed 32-bit] ) : Has different meanings for different layouts. In a named layout, this is which 'cell' the element is in.
widgetId ( uuid ) : Reference element only - The ID of the widget that this element references.
layout ( DashboardElementLayoutObject ) : Composite element only - The type of layout to use for child elements.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : Composite element only - The list of child elements by ID.
elementId ( uuid ) : The ID of the referenced element
widgets ( widgetsObject  [Max: 1024] ) : The pre-loaded definitions for all of the widgets in the dashboard. Except in the case of DASHBOARD widgets, this is populated only on read.
id ( uuid ) : The unique ID of the widget
title ( string ) : The title (display name) of the widget. Required
category ( string ) : The timeframe category of the widget. See WidgetCategory.
INTERVAL : Display data over discrete intervals for the time frame
AGGREGATE : Display summary data over the entire time frame
CURRENT : Display the current status against baseline or performance data
widgetType ( string ) : The type of widget. See WidgetType
CHART : The widget is a chart)
GRAPH : The widget is a graph
TABLE : The widget is a table
STATUS : The widget is a current status
ADM_DIAGRAM : The widget is a network diagram
DYN_ADM : The widget is a Dynamic Application Dependency Map
SITE_STATUS_MAP : The widget is a Site status map
availability ( string ) : Optional field indicating the availability of this widget depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
filter ( string ) : The optional widget-defined filter string.
maxItems ( integer [signed 32-bit] ) : The maximum number of results to return for this widget.
tags ( array ) : A set of tags for organizing the widget
owner ( DashboardOwnershipObject ) : Ownership information for the widget.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
options ( WidgetOptionsObject ) : The widget specific options. See WidgetOptions for details.
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
dynADM ( DynamicADMWidgetInfoObject ) : Information pertinent to dynamic ADM widgets
options ( DynamicADMWidgetInfoOptionsObject ) : Options for the dynamic ADM
type ( string ) : Indicates the type of dynamic ADM widget this is
DYNAMIC : Dynamic ADM Widget is saved to be dynamically discovered starting from the initial query state each time the widget is run.
startState ( DynamicADMStartStateObject ) : Indicates the starting state or 'query' of this dynamic ADM from which all results are built off of
clientIP ( ip address ) : IP address of the optional client node.
serverIP ( ip address ) : IP address of the optional server node.
application ( string ) : Application applicable to either the client or server node
fields ( fieldsObject  [Max: 64] ) : The list of widget fields
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
sortIndex ( integer [signed 32-bit] ) : The sort index for the field. This determines what order fields are sorted in. Currently 1 means sort, 0 means don't sort.
sortOrder ( string ) : When sortIndex is set, whether to sort ascending or descending.
ASCENDING : Sort the results in ascending order by this field
DESCENDING : Sort the results in descending order by this field
forceStream ( boolean [true|false] ) : Obsolete - Only valid for non-key fields. If provided and TRUE, then specify (via forcedStreamId) an override for which stream ID the field will be extracted from. When FALSE or omitted, the server automatically chooses.
forcedStreamId ( integer [signed 32-bit] ) : Obsolete - When forceStream is set, specifies the stream ID from which to extract the field data.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
children ( childrenObject  [Max: 16] ) : The collection of child fields when this is a composite field.
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
etag ( etag ) : Version control tag.
etag ( etag ) : Version control tag.
POST /dashboards Create a new dashboard
Parameters Model
dashboard
id ( uuid ) : The unique ID of the dashboard
owner ( DashboardOwnershipObject ) : The ownership information for the dashboard.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
title ( string ) : The title (display name) of the dashboard.
description ( string ) : An optional longer description of the dashboard.
filter ( string ) : The optional dashboard-defined filter string.
tags ( array ) : A list of tags for organizing and linking dashboards.
hideEmptyWidgets ( boolean [true|false] ) : Hide any widgets which contain no data.
hidden ( boolean [true|false] ) : Hide this dashboard from the My Dashboards panel.
availability ( string ) : Optional field indicating the availability of this dashboard depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
workflowInfo ( DashboardWorkflowInformationObject ) : Indicates workflow functions for this dashboard.
category ( string ) : Indicates what workflow this dashboard is part of (network, application, UC, etc).
NETWORK_PERFORMANCE : Network Performance Workflow.
APPLICATION_PERFORMANCE : Application Performance Workflow.
UC_PERFORMANCE : Unified Communications(UC) Workflow.
SITE_PERFORMANCE : Site Performance Workflow.
level ( integer [signed 32-bit] ) : Indicates the workflow level this dashboard belongs to.
drilldown ( DashboardWorkflowDrilldownInfoObject ) : Indicates drilldown specific information for this dashboard as it pertains to the workflow
allowed ( boolean [true|false] ) : Indicates whether the dashboard should show drilldowns or not.
drilldownType ( string ) : Indicates what type of one click drilldown occurs. For example, drilldown to a dashboard or the trace extraction form.
DASHBOARD : Drilldown should go to a dashboard.
TRACE_EXTRACTION : Drilldown should go to trace extraction.
POPUP : Drilldowns should behave in the standard manner, showing the drilldown popup.
drilldownDashboardId ( uuid ) : Indicates what dashboard one click workflow drilldowns go to.
layout ( DashboardElementLayoutObject ) : The type of layout to use for the dashboard. Typically this will be NAMED.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : The list of elements that are direct children of the dashboard.
elementId ( uuid ) : The ID of the referenced element
elements ( elementsObject  [Max: 512] ) : The definition of all dashboard elements in the dashboard.
id ( uuid ) : The unique ID of the element.
elementType ( string ) : Whether the element is a reference to a widget, or composite of other elements. See ElementType
REFERENCE : The element directly references a widget
COMPOSITE : The element contains other elements as children
filter ( string ) : The optional element-specific filter string.
containerIndex ( integer [signed 32-bit] ) : Has different meanings for different layouts. In a named layout, this is which 'cell' the element is in.
widgetId ( uuid ) : Reference element only - The ID of the widget that this element references.
layout ( DashboardElementLayoutObject ) : Composite element only - The type of layout to use for child elements.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : Composite element only - The list of child elements by ID.
elementId ( uuid ) : The ID of the referenced element
widgets ( widgetsObject  [Max: 1024] ) : The pre-loaded definitions for all of the widgets in the dashboard. Except in the case of DASHBOARD widgets, this is populated only on read.
id ( uuid ) : The unique ID of the widget
title ( string ) : The title (display name) of the widget. Required
category ( string ) : The timeframe category of the widget. See WidgetCategory.
INTERVAL : Display data over discrete intervals for the time frame
AGGREGATE : Display summary data over the entire time frame
CURRENT : Display the current status against baseline or performance data
widgetType ( string ) : The type of widget. See WidgetType
CHART : The widget is a chart)
GRAPH : The widget is a graph
TABLE : The widget is a table
STATUS : The widget is a current status
ADM_DIAGRAM : The widget is a network diagram
DYN_ADM : The widget is a Dynamic Application Dependency Map
SITE_STATUS_MAP : The widget is a Site status map
availability ( string ) : Optional field indicating the availability of this widget depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
filter ( string ) : The optional widget-defined filter string.
maxItems ( integer [signed 32-bit] ) : The maximum number of results to return for this widget.
tags ( array ) : A set of tags for organizing the widget
owner ( DashboardOwnershipObject ) : Ownership information for the widget.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
options ( WidgetOptionsObject ) : The widget specific options. See WidgetOptions for details.
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
dynADM ( DynamicADMWidgetInfoObject ) : Information pertinent to dynamic ADM widgets
options ( DynamicADMWidgetInfoOptionsObject ) : Options for the dynamic ADM
type ( string ) : Indicates the type of dynamic ADM widget this is
DYNAMIC : Dynamic ADM Widget is saved to be dynamically discovered starting from the initial query state each time the widget is run.
startState ( DynamicADMStartStateObject ) : Indicates the starting state or 'query' of this dynamic ADM from which all results are built off of
clientIP ( ip address ) : IP address of the optional client node.
serverIP ( ip address ) : IP address of the optional server node.
application ( string ) : Application applicable to either the client or server node
fields ( fieldsObject  [Max: 64] ) : The list of widget fields
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
sortIndex ( integer [signed 32-bit] ) : The sort index for the field. This determines what order fields are sorted in. Currently 1 means sort, 0 means don't sort.
sortOrder ( string ) : When sortIndex is set, whether to sort ascending or descending.
ASCENDING : Sort the results in ascending order by this field
DESCENDING : Sort the results in descending order by this field
forceStream ( boolean [true|false] ) : Obsolete - Only valid for non-key fields. If provided and TRUE, then specify (via forcedStreamId) an override for which stream ID the field will be extracted from. When FALSE or omitted, the server automatically chooses.
forcedStreamId ( integer [signed 32-bit] ) : Obsolete - When forceStream is set, specifies the stream ID from which to extract the field data.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
children ( childrenObject  [Max: 16] ) : The collection of child fields when this is a composite field.
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
etag ( etag ) : Version control tag.
etag ( etag ) : Version control tag.
GET /dashboards/{dashboardID} Retrieve a specific dashboard by ID
Result Model
dashboard
id ( uuid ) : The unique ID of the dashboard
owner ( DashboardOwnershipObject ) : The ownership information for the dashboard.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
title ( string ) : The title (display name) of the dashboard.
description ( string ) : An optional longer description of the dashboard.
filter ( string ) : The optional dashboard-defined filter string.
tags ( array ) : A list of tags for organizing and linking dashboards.
hideEmptyWidgets ( boolean [true|false] ) : Hide any widgets which contain no data.
hidden ( boolean [true|false] ) : Hide this dashboard from the My Dashboards panel.
availability ( string ) : Optional field indicating the availability of this dashboard depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
workflowInfo ( DashboardWorkflowInformationObject ) : Indicates workflow functions for this dashboard.
category ( string ) : Indicates what workflow this dashboard is part of (network, application, UC, etc).
NETWORK_PERFORMANCE : Network Performance Workflow.
APPLICATION_PERFORMANCE : Application Performance Workflow.
UC_PERFORMANCE : Unified Communications(UC) Workflow.
SITE_PERFORMANCE : Site Performance Workflow.
level ( integer [signed 32-bit] ) : Indicates the workflow level this dashboard belongs to.
drilldown ( DashboardWorkflowDrilldownInfoObject ) : Indicates drilldown specific information for this dashboard as it pertains to the workflow
allowed ( boolean [true|false] ) : Indicates whether the dashboard should show drilldowns or not.
drilldownType ( string ) : Indicates what type of one click drilldown occurs. For example, drilldown to a dashboard or the trace extraction form.
DASHBOARD : Drilldown should go to a dashboard.
TRACE_EXTRACTION : Drilldown should go to trace extraction.
POPUP : Drilldowns should behave in the standard manner, showing the drilldown popup.
drilldownDashboardId ( uuid ) : Indicates what dashboard one click workflow drilldowns go to.
layout ( DashboardElementLayoutObject ) : The type of layout to use for the dashboard. Typically this will be NAMED.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : The list of elements that are direct children of the dashboard.
elementId ( uuid ) : The ID of the referenced element
elements ( elementsObject  [Max: 512] ) : The definition of all dashboard elements in the dashboard.
id ( uuid ) : The unique ID of the element.
elementType ( string ) : Whether the element is a reference to a widget, or composite of other elements. See ElementType
REFERENCE : The element directly references a widget
COMPOSITE : The element contains other elements as children
filter ( string ) : The optional element-specific filter string.
containerIndex ( integer [signed 32-bit] ) : Has different meanings for different layouts. In a named layout, this is which 'cell' the element is in.
widgetId ( uuid ) : Reference element only - The ID of the widget that this element references.
layout ( DashboardElementLayoutObject ) : Composite element only - The type of layout to use for child elements.
type ( string ) : The type of layout to use. See LayoutType.
NAMED : A named layout type (e.g. 2cols1to1)
SIMPLE : A simple layout, either horizontal or vertical
GRID : A grid layout with filters per row/column
name ( string  [Max length: 512] ) : Named layout only - The name of the layout to use.
orientation ( string ) : Simple layout only - Whether to layout children horizontally or vertically.
HORIZONTAL : Layout children horizontally
VERTICAL : Layout children vertically
rows ( rowsObject ) : Grid layout only - The collection of rows in the grid.
filter ( string ) : The optional filter string for a grid row or column.
cols ( colsObject ) : Grid layout only - The collection of columns in the grid.
filter ( string ) : The optional filter string for a grid row or column.
children ( childrenObject  [Max: 128] ) : Composite element only - The list of child elements by ID.
elementId ( uuid ) : The ID of the referenced element
widgets ( widgetsObject  [Max: 1024] ) : The pre-loaded definitions for all of the widgets in the dashboard. Except in the case of DASHBOARD widgets, this is populated only on read.
id ( uuid ) : The unique ID of the widget
title ( string ) : The title (display name) of the widget. Required
category ( string ) : The timeframe category of the widget. See WidgetCategory.
INTERVAL : Display data over discrete intervals for the time frame
AGGREGATE : Display summary data over the entire time frame
CURRENT : Display the current status against baseline or performance data
widgetType ( string ) : The type of widget. See WidgetType
CHART : The widget is a chart)
GRAPH : The widget is a graph
TABLE : The widget is a table
STATUS : The widget is a current status
ADM_DIAGRAM : The widget is a network diagram
DYN_ADM : The widget is a Dynamic Application Dependency Map
SITE_STATUS_MAP : The widget is a Site status map
availability ( string ) : Optional field indicating the availability of this widget depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
filter ( string ) : The optional widget-defined filter string.
maxItems ( integer [signed 32-bit] ) : The maximum number of results to return for this widget.
tags ( array ) : A set of tags for organizing the widget
owner ( DashboardOwnershipObject ) : Ownership information for the widget.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
options ( WidgetOptionsObject ) : The widget specific options. See WidgetOptions for details.
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
dynADM ( DynamicADMWidgetInfoObject ) : Information pertinent to dynamic ADM widgets
options ( DynamicADMWidgetInfoOptionsObject ) : Options for the dynamic ADM
type ( string ) : Indicates the type of dynamic ADM widget this is
DYNAMIC : Dynamic ADM Widget is saved to be dynamically discovered starting from the initial query state each time the widget is run.
startState ( DynamicADMStartStateObject ) : Indicates the starting state or 'query' of this dynamic ADM from which all results are built off of
clientIP ( ip address ) : IP address of the optional client node.
serverIP ( ip address ) : IP address of the optional server node.
application ( string ) : Application applicable to either the client or server node
fields ( fieldsObject  [Max: 64] ) : The list of widget fields
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
sortIndex ( integer [signed 32-bit] ) : The sort index for the field. This determines what order fields are sorted in. Currently 1 means sort, 0 means don't sort.
sortOrder ( string ) : When sortIndex is set, whether to sort ascending or descending.
ASCENDING : Sort the results in ascending order by this field
DESCENDING : Sort the results in descending order by this field
forceStream ( boolean [true|false] ) : Obsolete - Only valid for non-key fields. If provided and TRUE, then specify (via forcedStreamId) an override for which stream ID the field will be extracted from. When FALSE or omitted, the server automatically chooses.
forcedStreamId ( integer [signed 32-bit] ) : Obsolete - When forceStream is set, specifies the stream ID from which to extract the field data.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
children ( childrenObject  [Max: 16] ) : The collection of child fields when this is a composite field.
fieldId ( integer [signed 32-bit] )
displayName ( string )
flags ( flagsObject )
legend (true|false). Whether or not the field is part of the legend. Should be set by default on all key fields.
key (true|false). Whether or not the field is a key field.
display (true|false). Whether or not to display the field. Should be set on all fields by default, can only be unset on sorting fields.
composite (true|false). Whether or not this is a composite field (i.e. has children)
dns (true|false). Whether or not the field supports showing ip as dns.
options ( WidgetOptionsObject ) : Allows overriding any of the widget options on a per-field basis. (e.g. changing graph type or number format)
numberFormat ( string ) : The number format to use for numeric fields. See NumberFormat
ACTUAL (Default) : Display numbers as their actual values
METRIC : Display numbers in metric, "K-Notation"
EXPONENTIAL : Display numbers in scientific notation
thresholdSource ( string ) : Status widgets only - the threshold to use when determining status. See ThresholdSource.
PERFORMANCE (Default) : Compare status against performance thresholds
BASELINE : Compare status against baseline thresholds
ipFormat ( string ) : IP key fields only - the format to use to display DNS and ip addresses. See IpFormat.
IP_ONLY (Default) : Shows only IP addresses in one column
DNS_ONLY : Shows DNS and unresolved IP addresses in one column
IP_AND_DNS : Shows IP only column and DNS only column
tcb ( boolean [true|false] ) : Show the Threshold Color Bar (TCB).
tcbShowSummaryField ( boolean [true|false] ) : Include the summary field for the TCB.
hideInvalidFields ( boolean [true|false] ) : Hides fields with invalid data.
graphType ( string ) : Graph widgets only - The type of graph to display. See GraphType.
LINE : A line graph
AREA : A filled-line graph
PLOT : A points graph
BAR : A bar graph
BAR_HORIZONTAL : A horizontal bar graph
BAR_THRESHOLD : A bar graph with threshold display
BAR_THRESHOLD_HORIZONTAL : A horizontal bar graph with threshold display
THRESHOLD : A threshold based graph
COLOR_BAR : A by-time color bar graph
stacked ( boolean [true|false] ) : Bar and Area graph widgets only - Whether or not to stack plots.
zoomControls ( boolean [true|false] ) : By time graph widgets only - Whether or not to show zoom controls on the graph.
chartType ( string ) : Chart widgets only - The type of chart to display. See ChartType
PIE : A pie chart
DONUT : A pie chart with a hole
statusType ( string ) : Status widgets only - The type of status element to display. See StatusType
DIAL : Horizontal status dial. Deprecated, do not use.
GAUGE : Status bar gauge. Deprecated, do not use.
ARC : Status vertical arc. Deprecated, do not use.
ICON : Status icon. Deprecated, do not use.
DUAL_DIAL_TCB : Combined status dial and TCB
showStatusValue ( boolean [true|false] ) : Status widgets only - Whether or not to display the numeric value for a status
etag ( etag ) : Version control tag.
etag ( etag ) : Version control tag.
PUT /dashboards/{dashboardID} Update a specific dashboard by ID
Parameters Model
dashboard
id ( uuid ) : The unique ID of the dashboard
owner ( DashboardOwnershipObject ) : The ownership information for the dashboard.
ownerType ( string ) : The type of ownership (See OwnerType)
SYSTEM : The dashboard or widget is a System-owned (non-editable) asset
SITE : The dashboard or widget is a Site-owned (editable, shareable) asset
USER : The dashboard or widget is a User-owned asset
DASHBOARD : The widget is owned by a dashboard (widget only)
userId ( uuid ) : The ID of the user that owns this resource, if eOwnerType is USER.
title ( string ) : The title (display name) of the dashboard.
description ( string ) : An optional longer description of the dashboard.
filter ( string ) : The optional dashboard-defined filter string.
tags ( array ) : A list of tags for organizing and linking dashboards.
hideEmptyWidgets ( boolean [true|false] ) : Hide any widgets which contain no data.
hidden ( boolean [true|false] ) : Hide this dashboard from the My Dashboards panel.
availability ( string ) : Optional field indicating the availability of this dashboard depending on Apex type.
LITE : Available for Lite mode only
LICENSED : Available for Licensed mode only
ALL : Available for all modes of Apex, Lite and licensed
workflowInfo ( DashboardWorkflowInformationObject ) : Indicates workflow functions for this dashboard.
category ( string ) : Indicates what workflow this dashboard is part of (network, application, UC, etc).
NETWORK_PERFORMANCE : Network Performance Workflow.
APPLICATION_PERFORMANCE : Application Performance Workflow.
UC_PERFORMANCE : Unified Communications(UC) Workflow.
SITE_PERFORMANCE : Site Performance Workflow.
level ( integer [signed 32-bit] ) : Indicates the workflow level this dashboard belongs to.
drilldown ( DashboardWorkflowDrilldownInfoObject ) : Indicates drilldown specific information for this dashboard as it pertains to the workflow
allowed ( boolean [true|false] ) : Indicates whether the dashboard should show drilldowns or not.
drilldownType ( string ) : Indicates what type of one click drilldown occurs. For example, drilldown to a dashboard or the trace extraction form.