How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThousandEyes Endpoint Agents API

The Endpoint Agents API from ThousandEyes — 6 operation(s) for endpoint agents.

ThousandEyes Endpoint Agents API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Endpoint Agents. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 6 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 7.0.100.

Requests are made against a single base URL, https://api.thousandeyes.com/v7.

8 operations 6 paths 51 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
7.0.100
Base URL
https://api.thousandeyes.com/v7
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ThousandEyes Endpoint Agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer authentication token

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Endpoint Agents 8
GET
/endpoint/agents
List endpoint agents
getEndpointAgents 8 params → 200401403429
GET
/endpoint/agents/{agentId}
Retrieve endpoint agent
getEndpointAgent 4 params → 200401403404429
PATCH
/endpoint/agents/{agentId}
Update endpoint agent
updateEndpointAgent 3 params body → 200401403404429
DELETE
/endpoint/agents/{agentId}
Delete endpoint agent
deleteEndpointAgent 3 params → 204401403404429
POST
/endpoint/agents/filter
Filter endpoint agents
filterEndpointAgents 5 params body → 200400401403429
GET
/endpoint/agents/connection-string
Get agent connection string
getEndpointAgentsConnectionString 1 param → 200401403429
POST
/endpoint/agents/{agentId}/enable
Enable endpoint agent
enableEndpointAgent 2 params → 200401403404429
POST
/endpoint/agents/{agentId}/disable
Disable endpoint agent
disableEndpointAgent 2 params → 200401403404429

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are EndpointAgent (35 properties), AgentSearchFilters (15 properties), CellularProfile (10 properties), Link (8 properties). Each schema is shown below with its type and property counts.

ValidationError
object
ListEndpointAgentsResponse
InterfaceHardwareType
string
EndpointUserProfile
object
2 properties 1 required
EndpointAgentEthernetProfile
object
Information about the ethernet connectivity of this device. Only present if the hardware type is ethernet.
1 property
BatteryMetrics
object
Battery metrics for the endpoint agent.
3 properties 2 required
EndpointBrowserExtension
object
6 properties
ComputerName
string
Returns only agents with the specified computer name. This is an exact match only.
ExpandEndpointAgentOptions
string
AgentSearchRequest
object
Parameters for filtering a list of agents.
3 properties
AccountId
string
A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint.
PaginationNextAndSelfLink
object
A links object containing a related link for forward pagination.
2 properties
ValidationErrorItem
object
3 properties
FilterEndpointAgentsResponse
VpnType
string
Name of the VPN provider.
InterfaceProfile
object
5 properties
AgentSearchSort
object
2 properties
BrowserType
string
EndpointVpnProfile
object
5 properties 2 required
Platform
string
OS platform types. Platform "linux" was recently renamed to "roomos".
EndpointAsnDetails
object
2 properties 1 required
EndpointAgentId
string
Unique ID of endpoint agent, from /endpoint/agents endpoint.
CellularNetworkGen
string
Cellular network generation.
AgentThresholdFilter
object
The metric is filtered based on the threshold value and operator provided.
3 properties
WirelessProfile
object
5 properties
CellularProfile
object
Cellular network profile information for a mobile endpoint agent.
10 properties
AgentSearchSortKey
string
UnauthorizedError
object
2 properties
Link
object
A hyperlink from the containing resource to a URI.
8 properties 1 required
EndpointAgentLocation
object
Approximate location of the agent.
3 properties
BatteryLevel
string
Battery level indicator.
AgentName
string
Returns only agents with the specified name. This is an exact match only.
AgentThresholdFilters
object
All filters are applied based on the conditional operator (and/or).
2 properties
ThresholdFilterOperator
string
EndpointClient
object
Information about the user who has the agent installed.
2 properties
SortOrder
string
Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values.
Error
object
5 properties
EndpointAgent
object
The EndpointAgent object, which may include multiple clients.
35 properties
ConnectionString
object
2 properties
EndpointAgents
object
A list of EndpointAgents.
2 properties
AgentLicenseType
string
ExternalMetadata
array
List of external metadata assigned to the endpoint agent. Visible only if the expandAgent=externalMetadata query parameter is included.
ExternalMetadataItem
object
2 properties
AgentSearchFilters
object
15 properties
Status
string
Status of the endpoint agent in ThousandEyes. Disabled agents don't report data.
EndpointAgentUpdate
object
The EndpointAgentUpdate object contains supported fields for updates.
2 properties
PaginationNextLink
object
A links object containing a related link for forward pagination.
1 property
SelfLinks
object
A links object containing the self link.
1 property
AddressType
string
AddressProfile
object
A description of the IPs assigned to this machine.
5 properties
ConditionalOperator
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thousandeyes-endpoint-agents-api-openapi.yml Raw ↑

Other APIs ThousandEyes publishes across the network.

ThousandEyes Account Groups API
ThousandEyes Agent Proxies API
ThousandEyes Agent to Agent Instant Tests API
ThousandEyes Agent to Agent Tests API
ThousandEyes Agent To Server Endpoint Dynamic Tests API
ThousandEyes Agent to Server Endpoint Instant Scheduled Tests API
ThousandEyes Agent to Server Endpoint Scheduled Tests API
ThousandEyes Agent to Server Instant Tests API
ThousandEyes Agent to Server Tests API
ThousandEyes Alert Rules API
ThousandEyes Alert Suppression Windows API
ThousandEyes Alerts API
Where this information came from

This is an independent, third-party profile of ThousandEyes Endpoint Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.