| (all) |
agentSelectorConfig |
object |
{agentIds: array of strings, agentSelectorType: enum value, labelIds: array of longs, maxMachines: [1-10000]} |
Agent selection object |
| (all) |
agentSelectorConfig.agentIds |
array of strings |
see notes |
List of agent ids. Must be set if agentSelectorType == SPECIFIC_AGENTS |
| (all) |
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 |
| (all) |
agentSelectorConfig.labelIds |
array of longs |
see notes |
List of label ids. Must be set if agentSelectorType == LIST_OF_LABELS |
| (all) |
agentSelectorConfig.maxMachines |
integer |
[1-10000] |
Upper limit of machines for the test |
| (all) |
alertsEnabled |
integer |
0 or 1 |
1 to enable alerts, or 0 to disable alerts |
| (all) |
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 |
| HTTP Server |
authType |
string |
"NONE", "BASIC", or "NTLM" |
Type of authentication for the test |
| (all) |
bandwidthMeasurements |
integer |
0 or 1 |
1 to measure bandwidth |
| (all) |
bgpMeasurements |
integer |
0 or 1 |
1 to enable bgp measurements |
| HTTP Server |
contentRegex |
string |
[Regular Expressions][regexp-quickref] |
This field does not require escaping |
| (all) |
createdBy |
string |
Username (email@company.com) |
User's email |
| (all) |
createdDate |
string |
YYYY-MM-DD HH:mm:ss formatted date |
Shown in UTC |
| (all) |
enabled |
integer |
0 or 1 |
1 to enable the test, 0 to disable the test |
| (all) |
flagPing |
boolean |
true or false |
Indicates if the test should run ping |
| (all) |
flagTraceroute |
boolean |
true or false |
Indicates if the test should run traceroute |
| HTTP Server |
followRedirects |
integer |
0 or 1 |
0 to not follow HTTP/301 or HTTP/302 redirect directives. |
| HTTP Server |
httpTargetTime |
integer |
(100..5000) |
Target time for HTTP server completion; specified in milliseconds |
| HTTP Server |
httpTimeLimit |
integer |
(5000..60000) |
Target time for HTTP Server timeout; specified in milliseconds |
| HTTP Server |
httpVersion |
integer |
[1,2] |
2 for prefer HTTP/2, 1 for HTTP/1.1 only |
| (all) |
interval |
integer |
[60, 120, 300, 600, 900, 1800, 3600] |
Value in seconds |
| (all) |
modifiedBy |
string |
Username (email@company.com) |
User's email |
| (all) |
modifiedDate |
string |
YYYY-MM-DD HH:mm:ss formatted date |
Shown in UTC |
| (all) |
mtuMeasurements |
integer |
0 or 1 |
1 to measure MTU sizes on network tests |
| (all) |
networkMeasurements |
integer |
0 or 1 |
1 to perform network tests |
| (all) |
port |
integer |
(1..65535) |
TCP port used to perform the test; if ICMP is selected, -1 is returned |
| HTTP Server |
postBody |
string |
see notes |
If the post body is set to something other than empty, the requestMethod will be set to POST |
| (all) |
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. |
| (all) |
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. |
| (all) |
savedEvent |
integer |
0 or 1 |
Indicates 1 for a saved event, 0 for a normal test |
| (all) |
server |
string |
(any) |
Target domain name or IP address |
| HTTP Server |
sslVersion |
string |
corresponds to sslVersionId |
Reflects the verbose ssl protocol version used by a test |
| HTTP Server |
sslVersionId |
integer |
[0,3,4,5,6] |
0 for default (Auto), 6 for TLS1.2, 5 for TLS1.1, 4 for TLS1.0, 3 for SSLv3 |
| (all) |
testId |
integer |
unique ID of test |
Each test is assigned a unique ID; this is used to access test data from other endpoints |
| (all) |
testName |
string |
(any) |
Test name must be unique |
| (all) |
type |
string |
type of test being queried |
Test type is implicit in the test creation url |
| HTTP Server |
url |
string |
see notes |
Target for the test |
| HTTP Server |
useNtlm |
integer |
0 or 1 |
1 for NTLM, 0 for Basic Authentication. Requires username/password to be set |
| (all) |
usePublicBgp |
integer |
0 or 1 |
Use all the public BGP montiors |
| HTTP Server |
userAgent |
string |
see notes |
user-agent string to be provided during the test |
| HTTP Server |
username |
string |
see notes |
username to be used for Basic/NTLM authentication |
| HTTP Server |
verifyCertificate |
integer |
0 or 1 |
0 to ignore certificate errors |