REST examples
Copy
NodeToNode Request:
{
"identifier": "",
"isMesh": "0",
"testtypeId": "5163",
"fromProbeId": "2",
"toProbeId": "3",
"meshId": "2",
"enforceSchedule": "0",
"frequency": "2",
"startDate": "2020-08-11T18:30:44Z",
"endDate": "2120-08-11T18:16:48Z",
"testTemplateExecutionId": "0",
"topology": "NodeToNode",
"fromIps": "Default",
"toIps": "Default",
"parameters": {
"basic": [
{
"id": "1",
"value": "30"
},
{
"id": "4",
"value": "5"
}
],
"pairs": [
{
"id": "15175",
"parameters": [
{
"id": "105",
"value": "BestEffort"
}
]
},
{
"id": "15176",
"name": "TCP from->to N pairs COS 2",
"parameters": [
{
"id": "105",
"value": "BestEffort"
}
]
},
{
"id": "15177",
"name": "TCP from->to N pairs COS 3",
"parameters": [
{
"id": "105",
"value": "BestEffort"
}
]
}
]
},
"alarm": {
"trigger": {
"failure": "0",
"error": "0",
"change": "0",
"outlier": "0"
},
"notification": {
"email": {
"enabled": false,
"address": ""
},
"snmp": {
"enabled": false
}
}
},
"thresholds": [
{
"pairId": "15175",
"pairName": "TCP from->to N pairs COS 1",
"metric": "Throughput from->to (Mbps)",
"value": "5571508.445",
"operator": "1",
"unit": "Mbps",
"factor": "1",
"autoLearnEnabled": "0",
"sensitivity": 95,
"outlier": {
"enabled": "0",
"windowSec": "1740",
"windowPct": "52"
}
},
{
"pairId": "15176",
"pairName": "TCP from->to N pairs COS 2",
"metric": "Throughput from->to (Mbps)",
"value": "5229714.123",
"operator": "1",
"unit": "Mbps",
"factor": "1",
"autoLearnEnabled": "1",
"sensitivity": 99,
"outlier": {
"enabled": "1",
"windowSec": "1800",
"windowPct": "50"
}
},
{
"pairId": "15177",
"pairName": "TCP from->to N pairs COS 3",
"metric": "Throughput from->to (Mbps)",
"value": "4844271.8789",
"operator": "1",
"unit": "Mbps",
"factor": "1",
"autoLearnEnabled": "1",
"sensitivity": 99.9,
"outlier": {
"enabled": "1",
"windowSec": "1800",
"windowPct": "50"
}
}
]
}
RealService Request:
{
"identifier": "api call",
"isMesh": "0",
"testtypeId": "7148",
"fromProbeId": "1",
"toProbeId": "0",
"meshId": "0",
"enforceSchedule": "0",
"frequency": "4",
"startDate": "2020-08-14T15:43:32Z",
"endDate": "2120-08-14T15:43:32Z",
"testTemplateExecutionId": "0",
"topology": "RealService",
"parameters": {
"basic": [
{
"id": "202",
"description": "Destination Servers",
"value": "www.test.com"
},
{
"id": "203",
"description": "Interval",
"value": "0.02"
},
{
"id": "204",
"description": "Count",
"value": "100"
},
{
"id": "205",
"description": "Packet Size",
"value": "100"
},
{
"id": "227",
"description": "ip protocol",
"value": "ipv4"
},
{
"id": "3006",
"description": "Class of Service",
"value": "0"
},
{
"id": "3007",
"description": "Jitter Calculation",
"value": "1"
}
]
},
"thresholds": [
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Availability",
"value": "1",
"operator": "1",
"unit": null,
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": 100
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Jitter (ms)",
"value": "8",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Jitter Max (ms)",
"value": "8",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Jitter standard deviation",
"value": "2",
"operator": "0",
"unit": null,
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Packet loss",
"value": "1",
"operator": "0",
"unit": null,
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Round trip time avg (ms)",
"value": "300",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Round trip time max (ms)",
"value": "400",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Round trip time min (ms)",
"value": "300",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": null,
"outlier": {
"enabled": "1",
"windowSec": "1800",
"windowPct": "50"
}
},
{
"pairId": "7148",
"pairName": "ICMP Test",
"metric": "Standard deviation (ms)",
"value": "20",
"operator": "0",
"unit": "ms",
"factor": "1",
"autoLearnEnabled": 0,
"sensitivity": "0"
}
] }
create a Test using Mesh Id:
{
"identifier": "MeshTestFromAPI",
"isMesh": "1",
"testtypeId": "5129",
"meshId": "1",
"enforceSchedule": "0",
"frequency": "5",
"startDate": "2020-08-14T15:50:18Z",
"endDate": "",
"testTemplateExecutionId": "0",
"topology": "Mesh",
"parameters": {
"basic": [
{
"id": "1",
"description": "Traffic Duration",
"value": "30"
},
{
"id": "105",
"description": "DSCP Setting",
"value": "BestEffort"
}
]
}
}