v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBSynthetics
Edit a Network Path test
put/api/v2/synthetics/tests/network/{public_id}
Path parameters
public_idstring required
The public ID of the Network Path test to edit.
Request body
Example request
{
"data": {
"attributes": {
"config": {
"assertions": [
{
"operator": "lessThan",
"property": "avg",
"target": 500,
"type": "latency"
}
],
"request": {
"e2e_queries": 50,
"max_ttl": 30,
"port": 443,
"tcp_method": "prefer_sack",
"traceroute_queries": 3
}
},
"locations": [
"aws:us-east-1",
"agent:my-agent-name"
],
"message": "Network Path test notification",
"monitor_id": 12345678,
"name": "Example Network Path test",
"options": {
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"public_id": "abc-def-123",
"status": "live",
"subtype": "tcp",
"tags": [
"env:production"
],
"type": "network"
},
"type": "network"
}
}Response
OK
Example response
{
"data": {
"attributes": {
"config": {
"assertions": [
{
"operator": "lessThan",
"property": "avg",
"target": 500,
"type": "latency"
}
],
"request": {
"e2e_queries": 50,
"max_ttl": 30,
"port": 443,
"tcp_method": "prefer_sack",
"traceroute_queries": 3
}
},
"locations": [
"aws:us-east-1",
"agent:my-agent-name"
],
"message": "Network Path test notification",
"monitor_id": 12345678,
"name": "Example Network Path test",
"options": {
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"public_id": "abc-def-123",
"status": "live",
"subtype": "tcp",
"tags": [
"env:production"
],
"type": "network"
},
"id": "abc-def-123",
"type": "network_test"
}
}