API Changelog
ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.
The following list documents a running list of changes to version 6 of the ThousandEyes API. Each release date is linked to the specific release notes for that release, for which Authentication is required. For details related to other versions of the ThousandEyes API, see the links on the left sidebar.
For more information, see the Changelog
ThousandEyes API v6 End of Life Notification
This is a reminder about the end-of-life of API v6. API v6 will no longer be supported as of May 27th, 2025.
Our v7 API introduces new capabilities for developers and DevOps-focused customers, ranging from standardization to performance and improved documentation. It aims to deliver a single cohesive API surface for all ThousandEyes product areas. The goal of our v7 API is to simplify and improve use cases while increasing interoperability with tools common to operations workflows.
According to our API support policy, prior versions of our API are supported for 1 year following an initial 90-day notification period.
May 27, 2024
Deprecation
- ThousandEyes API v6 has been deprecated. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.
New
- Support for
allowUnsafeLegacyRenegotiation field in the following endpoints for test types http-server, page-load, and web-transactions:
- List tests (
/tests)
- Retrieve test (
/tests/{testType}/{testId})
- Create test (
/tests/{testType}/new)
- Update test (
/tests/{testType}/{testId}/update)
New
api test type. For more information, see Test metadata- Support for alerts for API test type.
New
embedded return type to Usage API
New
interfaceIpMapping field to agents API
New
- 60 minute
interval to agent-to-server tests API
New
/endpoint-tests/{testType}/new and endpoint-automated-session-tests/new endpoints return flagPing, flagTraceroute, agentSelectorConfig and pathtraceInSession fields.
New
- Added support for endpoint test labels.
Updates
- The
alertId attribute in the alerts and alertdetail API has been converted from an integer to a string. This update takes effect from 1 August, 2023.
New
- Added an endpoint for getting a list of the agent proxies:
/agents/proxies.
New
- New attribute
pageId in endpoint user sessions list response API to be able to correlate with specific web page details. Page ID will be unique for data generated after 4th July 2023.
Updates
- When creating or updating page load tests using the API, the
httpInterval field is now deprecated. To solve UX issues in the page load timeline view, the page load test interval and http test interval values must be equal. When creating a page load test, the interval field will provide the value for both the page load test interval and http test interval. When updating a page load test where the interval and httpInterval fields have unequal values, one of the two fields must be updated so that the values are equal before the update test request will succeed.
Updates
- Updated Endpoint Automated Session Tests APIs to support pagination. The returned "nextPage" URL should be used to go through all pages.
New
EndpointAgentsEssentials fields information on the Usage metadata page.
New
/usage endpoint now supports endpointAgentsEssentials field.
New
- Agent list
/agents now supports the localResolutionPrefixes field.
- Agent details
/agents/{agentId} now supports the localResolutionPrefixes field.
- Agent details
/agents/{agentId}/update now supports the localResolutionPrefixes field.
New
- Web Transaction and Page Load tests have a new parameter:
clientCertificate.
New
- new attribute
id in alert and alert details API response to represent 128-bit alphanumeric UUID of alert
Removed
id attribute in alerts and alertdetail api
Removed
verifySslCertificates agent flag is removed.
New
- Endpoint agent list
/endpoint-agents/ now supports asnDetails field.
- Endpoint agent details
/endpoint-agents/{agentId} now supports asnDetails field.
- Endpoint Test Data
/endpoint-data/tests/net/path-vis/{testId} now supports asnDetails field.
- Endpoint Test Data
/endpoint-data/tests/net/path-vis/{testId}/{agentId}/{roundId} now supports asnDetails field.
- Endpoint Test Data
/endpoint-data/automated-session-tests/net/path-vis/{testId} now supports asnDetails field.
- Endpoint Test Data
/endpoint-data/automated-session-tests/net/path-vis/{testId}/{agentId}/{roundId} now supports asnDetails field.
Removed
Alert-Grid widget has now been removed from the platform and from snapshots
New
- Added a new endpoint for deleting endpoint agents:
/endpoint-agents/{agentId}
New
- Added the
experienceScore field to Endpoint user session APIs.
New
- Web Transaction and Page Load tests have a new parameters:
blockDomains, disableScreenshot, allowMicAndCamera, allowGeolocation, browserLanguage, pageLoadingStrategy.
Deprecated
- Reports v6 API is deprecated when dashboards and reports merge.
New
- Added the
continuousMode field to agent-to-server tests.
New
- Added two new Admin APIs for obtaining & updating usage quotas
Updates
- Added documentation to indicate that
/v6/snapshots cannot be used to create snapshots of Endpoint Agent scheduled tests.
New
- Added a new Endpoint API for transferring agents.
New
networkProtocol, tcpProbeMode and pathtraceInSession fields added to Endpoint tests.