Get BGP test

GET {{baseUrl}}/tests/bgp/:testId?aid=1234&expand=alert-rule,monitor

Returns details for a BGP test, including name, intervals, targets, alert rules and agents.

Request Params

KeyDatatypeRequiredDescription
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
expandstringOptional parameter on whether or not to expand the test sub-resources. By default no expansion takes place if the query parameter is not present. To expand the monitors sub-resource, pass the ?expand=monitor query.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"prefix":"sed irure","createdBy":"user@user.com","createdDate":"2022-07-17T22:00:54Z","description":"ThousandEyes Test","liveShare":false,"modifiedBy":"user@user.com","modifiedDate":"2022-07-17T22:00:54Z","savedEvent":false,"testId":"281474976710706","testName":"ThousandEyes Test","type":"agent-to-server","_links":{"self":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}]},"labels":[{"labelId":"961","name":"Artem label","isBuiltin":false},{"labelId":"961","name":"Artem label","isBuiltin":false}],"sharedWithAccounts":[{"aid":"1234","name":"Account name"},{"aid":"1234","name":"Account name"}],"enabled":true,"monitors":[{"countryId":"GB","monitorId":"1234","ipAddress":"4.69.184.193","network":"Level 3 Communications, Inc. (AS 3356)","monitorType":"public","monitorName":"Seattle, WA"},{"countryId":"GB","monitorId":"1234","ipAddress":"4.69.184.193","network":"Level 3 Communications, Inc. (AS 3356)","monitorType":"public","monitorName":"Seattle, WA"}],"includeCoveredPrefixes":true,"usePublicBgp":true,"alertsEnabled":true,"alertRules":[{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"},{"ruleId":"127094","ruleName":"The End of the Internet","expression":"((hops((hopDelay \u003e= 100 ms))))","direction":"to-target","isDefault":true,"alertType":"http-server","minimumSources":10,"minimumSourcesPct":99,"roundsViolatingMode":"exact","roundsViolatingOutOf":5,"roundsViolatingRequired":2,"sensitivityLevel":"medium","severity":"major"}]}