Qodex.ai

Get API test

GET {{baseUrl}}/tests/api/:testId?aid=1234&expand=agent,monitor

Returns details for a API test configuration. Please use expand parameter to access sub-resources such as 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 is going to take place if the query parameter is not present. If the user wishes to expand the agents sub-resource, they need to pass the ?expand=agent query.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"interval":60,"requests":[{"name":"Step 1","url":"https://api.thousandeyes.com/v7/status","assertions":[{"name":"status-code","operator":"is","value":"200"},{"name":"status-code","operator":"is","value":"200"}],"authType":"none","body":"in","collectApiResponse":true,"headers":[{"key":"x-custom-header","value":"keep-alive"},{"key":"x-custom-header","value":"keep-alive"}],"method":"get","username":"ThousandEyesUserName","variables":[{"name":"myTestName","value":"tests[0].name"},{"name":"myTestName","value":"tests[0].name"}],"waitTimeMs":0},{"name":"Step 1","url":"https://api.thousandeyes.com/v7/status","assertions":[{"name":"status-code","operator":"is","value":"200"},{"name":"status-code","operator":"is","value":"200"}],"authType":"none","body":"sed","collectApiResponse":true,"headers":[{"key":"x-custom-header","value":"keep-alive"},{"key":"x-custom-header","value":"keep-alive"}],"method":"get","username":"ThousandEyesUserName","variables":[{"name":"myTestName","value":"tests[0].name"},{"name":"myTestName","value":"tests[0].name"}],"waitTimeMs":0}],"url":"www.thousandeyes.com","alertsEnabled":true,"enabled":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"}],"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"}],"followRedirects":true,"mtuMeasurements":false,"networkMeasurements":true,"numPathTraces":3,"pathTraceMode":"classic","predefinedVariables":[{"name":"myUsername","value":"ThousandEyesAccountUserName"},{"name":"myUsername","value":"ThousandEyesAccountUserName"}],"probeMode":"auto","protocol":"tcp","sslVersionId":"0","targetTime":1,"timeLimit":30,"credentials":["3247","1051"],"bgpMeasurements":true,"usePublicBgp":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"}],"agents":[{"agentType":"enterprise-cluster","ipAddresses":["99.139.65.220","9bbd:8a0a:a257:5876:288b:6cb2:3f36:64ce"],"publicIpAddresses":["192.168.1.78","f9b2:3a21:f25c:d300:03f4:586d:f8d6:4e1c"],"network":"AT\u0026T Services, Inc. (AS 7018)","agentId":"281474976710706","agentName":"thousandeyes-stg-va-254","location":"San Francisco Bay Area","countryId":"US","enabled":true,"prefix":"99.128.0.0/11","verifySslCertificates":true},{"agentType":"enterprise-cluster","ipAddresses":["99.139.65.220","9bbd:8a0a:a257:5876:288b:6cb2:3f36:64ce"],"publicIpAddresses":["192.168.1.78","f9b2:3a21:f25c:d300:03f4:586d:f8d6:4e1c"],"network":"AT\u0026T Services, Inc. (AS 7018)","agentId":"281474976710706","agentName":"thousandeyes-stg-va-254","location":"San Francisco Bay Area","countryId":"US","enabled":true,"prefix":"99.128.0.0/11","verifySslCertificates":true}]}