Endpoint Scheduled Tests

`GET /v6/endpoint-tests` Endpoint scheduled test list

Returns a list of all endpoint scheduled tests configured in ThousandEyes. This list does not contain saved events.

Optional (Querystring) Parameters

format=json|xml optional, specifies the format of output requested. See Output Formats for more information
aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

There is no request body for this request.

Response

Sends back an array of endpoint tests. See Scheduled Endpoint Test Metadata page for information on fields returned by this endpoint.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-tests.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointTest": [ { "alertsEnabled": 0, "apiLinks": [...], "bandwidthMeasurements": 0, "bgpMeasurements": 0, "createdBy": "API Sandbox User (noreply@thousandeyes.com)", "createdDate": "2018-08-25 16:56:50", "enabled": 1, "interval": 60, "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)", "modifiedDate": "2018-08-25 16:57:59", "mtuMeasurements": 0, "networkMeasurements": 1, "port": -1, "protocol": "ICMP", "savedEvent": 0, "server": "www.thousandeyes.com", "testId": 282, "testName": "ThousandeEyes", "type": "agent-to-server", "usePublicBgp": 0 }, ... ] }

For more information on our response status codes, see the response status codes documentation.

`GET /v6/endpoint-tests/{testType}` Endpoint scheduled test list by type

Returns a list of all endpoint scheduled tests of the type specified, configured in ThousandEyes. The list does not contain saved events.

Optional (Querystring) Parameters

format=json|xml optional, specifies the format of output requested. See Output Formats for more information
aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

{testType} corresponds to any of the following options:
- agent-to-server
- http-server
There is no request body for this request.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-tests/http-server.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

Response

Sends back an array of tests matching the requested test type. See Scheduled Endpoint Test Metadata page for information on fields returned by this endpoint.

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:54 GMT Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 238 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-1

Body

{ "endpointTest": [ { "alertsEnabled": 0, "apiLinks": [...], "authType": "NONE", "bandwidthMeasurements": 0, "bgpMeasurements": 0, "createdBy": "API Sandbox User (noprely@thousandeyes.com)", "createdDate": "2018-08-18 18:33:23", "enabled": 1, "followRedirects": 1, "httpTargetTime": 1000, "httpTimeLimit": 5000, "httpVersion": 1, "interval": 60, "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)", "modifiedDate": "2018-08-25 17:22:54", "mtuMeasurements": 0, "networkMeasurements": 1, "port": 443, "protocol": "TCP", "savedEvent": 0, "server": "developer.thousandeyes.com", "sslVersion": "Auto", "sslVersionId": 0, "testId": 273, "testName": "Developer Reference", "type": "http-server", "url": "https://developer.thousandeyes.com/", "useNtlm": 0, "usePublicBgp": 0, "username": "", "verifyCertificate": 1 }, ... ] }

For more information on our HTTP response status codes, see the response status codes documentation.

`GET /v6/endpoint-tests/{testId}` Endpoint scheduled test details

Returns details for an endpoint scheduled test, including test type, name, intervals, targets and alert rules.

Optional (Querystring) Parameters

format=json|xml optional, specifies the format of output requested. See Output Formats for more information
aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

{testId} the ID of the endpoint scheduled test you wish to retrieve
There is no request body for this request.

Response

Sends back all metadata for the requested endpoint scheduled test. See Scheduled Endpoint Test Metadata page for more information on fields returned by this endpoint.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-tests/282.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:57 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 235 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-5

Body

For more information on our HTTP response status codes, see the response status codes documentation.

Endpoint test metadata

Endpoint test fields are shown in the table below. Endpoint tests can’t be created or updated using the API.

Fields are listed alphabetically by test type below.

These fields are system-generated and read only, and displayed as part of test metadata.

Test Type	Field	Data Type	Acceptable Values	Notes
(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
(all)	bandwidthMeasurements	integer	0 or 1	1 to measure bandwidth
(all)	bgpMeasurements	integer	0 or 1	1 to enable bgp measurements
(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)	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
(all)	protocol	string	`TCP` or `ICMP`	Protocol used to perform the test
(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
(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
(all)	usePublicBgp	integer	0 or 1	Use all the public BGP montiors
HTTP Server	authType	string	“NONE”, “BASIC”, or “NTLM”	Type of authentication for the test
HTTP Server	contentRegex	string	Regular Expressions	This field does not require escaping
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
HTTP Server	postBody	string	see notes	If the post body is set to something other than empty, the requestMethod will be set to POST
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
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
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

DEVELOPER REFERENCE

Search Results

Overview

Instant tests

Tests

Test Data

Endpoint Data