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 Enterprise Agent Cluster API

The Enterprise Agent Cluster API from ThousandEyes — 2 operation(s) for enterprise agent cluster.

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

Tagged areas include Enterprise Agent Cluster. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 operations across 2 paths, and defines 53 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.

2 operations 2 paths 53 schemas 2 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 Enterprise Agent Cluster 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Enterprise Agent Cluster 2
POST
/agents/{agentId}/cluster/assign
Add member to Enterprise Agent cluster
assignAgentToCluster 3 params body → 200400401403404429500502
POST
/agents/{agentId}/cluster/unassign
Remove member from Enterprise Agent cluster
unassignAgentFromCluster 3 params body → 200400401403404429500502

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are EnterpriseAgentData (16 properties), SimpleTest (14 properties), Link (8 properties), Error (5 properties). Each schema is shown below with its type and property counts.

NotificationRules
object
1 property
ValidationError
object
InterfaceIpMapping
object
2 properties
Coordinates
object
Geographic coordinates for agent location.
2 properties
CloudEnterpriseAgents
object
2 properties
AgentLabel
object
2 properties
NotificationRule
object
5 properties
EnterpriseAgentData
object
16 properties
TestCreatedDate
string
UTC created date (ISO date-time format).
EnterpriseAgentDetail
EnterpriseAgentSerialNumber
string
Serial number of an enterprise agent or cluster member device. This field is not available for Cloud Agents.
TestCreatedBy
string
User that created the test.
ValidationErrorItem
object
3 properties
ErrorDetailCode
string
Code for the agent error.
EnterpriseAgentType
string
Enterprise agent type.
AgentResponse
TestLinks
object
A list of links that can be accessed to get more information
2 properties
TestIds
array
List of test IDs assigned to the agent.
AgentClusterAssignRequest
object
1 property
EnterpriseClusterAgentType
string
Enterprise Cluster agent type.
EnterpriseAgent
SimpleTest
object
Each test includes additional fields depending on its type. Refer /tests/{type} endpoint to know the set of fields returned by a given type.
14 properties
ClusterMembers
array
If an enterprise agent is clustered, detailed information about each cluster member will be shown as array entries in the clusterMembers field. This field is n…
AgentDetailsExpand
string
ClusterMember
SimpleAgent
object
EnterpriseAgentResponseExpands
object
5 properties
Enabled
boolean
Test is enabled.
TestType
string
This is a read only value, as test type is implicit in the test creation url.
CloudEnterpriseAgent
ErrorDetail
object
2 properties
UnauthorizedError
object
2 properties
CloudAgentType
string
Cloud agent type.
Link
object
A hyperlink from the containing resource to a URI.
8 properties 1 required
TestResults
array
Reference to the test results.
CloudAgentDetail
object
EnterpriseAgentIpv6Policy
string
IP version policy, (Enterprise Agents and Enterprise Clusters only)
TestInterval
integer
Interval between test runs in seconds.
Error
object
5 properties
AgentBase
object
3 properties
AccountGroup
object
2 properties
AgentTag
object
3 properties
CloudEnterpriseAgentType
string
Type of the agent.
NetworkProviderInfo
object
Information about the network provider that owns the agent's public IP prefix.
3 properties
TestSelfLink
EnterpriseAgentClusterDetail
AgentDetails
NetworkProviderType
string
Classification of the agent's network provider.
AgentClusterUnassignRequest
object
1 property
SelfLinks
object
A links object containing the self link.
1 property
SimpleEnterpriseAgent
AccountGroupId
string
A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint.
EnterpriseAgentState
string
State of the agent.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thousandeyes-enterprise-agent-cluster-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 Enterprise Agent Cluster 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.