| agentSelectorConfig |
object |
{agentIds: array of strings, agentSelectorType: enum value, labelIds: array of longs, maxMachines: [1-10000]} |
Agent selection object |
| agentSelectorConfig.agentIds |
array of strings |
see notes |
List of agent ids. Must be set if agentSelectorType == SPECIFIC_AGENTS |
| agentSelectorConfig.agentSelectorType |
string |
ANY_AGENT, SPECIFIC_AGENTS, LIST_OF_LABELS |
Agent selection type: either all agents available, or list of agents, of list of agent labels |
| agentSelectorConfig.labelIds |
array of longs |
see notes |
List of label ids. Must be set if agentSelectorType == LIST_OF_LABELS |
| agentSelectorConfig.maxMachines |
integer |
[1-10000] |
Upper limit of machines for the test |
| alertsEnabled |
integer |
0 or 1 |
1 to enable alerts, or 0 to disable alerts |
| apiLinks |
array of apiLinks objects |
Array of apiLink objects, showing rel and href elements |
Self links to endpoint to pull test metadata, and data links to endpoint for test data |
| application |
string |
WEBEX,MSTEAMS,ZOOM |
Which supported application to monitor |
| bandwidthMeasurements |
integer |
0 or 1 |
1 to measure bandwidth |
| bgpMeasurements |
integer |
0 or 1 |
1 to enable bgp measurements |
| createdBy |
string |
Username (email@company.com) |
User's email |
| createdDate |
string |
YYYY-MM-DD HH:mm:ss formatted date |
Shown in UTC |
| enabled |
integer |
0 or 1 |
1 to enable the test, 0 to disable the test |
| flagPing |
boolean |
true or false |
Indicates if the test should run ping |
| flagTraceroute |
boolean |
true or false |
Indicates if the test should run traceroute |
| interval |
integer |
[60, 120, 300, 600, 900, 1800, 3600] |
Value in seconds |
| modifiedBy |
string |
Username (email@company.com) |
User's email |
| modifiedDate |
string |
YYYY-MM-DD HH:mm:ss formatted date |
Shown in UTC |
| mtuMeasurements |
integer |
0 or 1 |
1 to measure MTU sizes on network tests |
| networkMeasurements |
integer |
0 or 1 |
1 to perform network tests |
| port |
integer |
(1..65535) |
TCP port used to perform the test; if ICMP is selected, -1 is returned |
| protocol |
string |
TCP, ICMP, PREFER_TCP or ICMP_WITH_TCP_CONNECT |
Protocol used to perform the test . If PREFER_TCP is returned, and if an agent doesn't support TCP, then it’s as if the test was configured as ICMP_WITH_TCP_CONNECT. |
| pathtraceInSession |
boolean |
true or false |
Indicates if test should perform path trace "in session". This option initiates a TCP session with the target server, and sends path trace packets within the TCP session. |
| savedEvent |
integer |
0 or 1 |
Indicates 1 for a saved event, 0 for a normal test |
| server |
string |
(any) |
Target domain name or IP address |
| testId |
integer |
Unique ID of test |
Each test is assigned a unique ID; this is used to access test data from other endpoints |
| testName |
string |
(any) |
Test name must be unique |
| type |
string |
Type of test being queried |
Test type is implicit in the test creation url |
| usePublicBgp |
integer |
0 or 1 |
Use all the public BGP monitors |