ThousandEyes SIP Server Tests API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include SIP Server Tests. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 73 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.
5 operations2 paths73 schemas1 DELETE2 GET1 POST1 PUT
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 SIP Server Tests 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are SipServerProperties (13 properties), AlertRule (13 properties), UnexpandedInstantTest (11 properties), Link (8 properties). Each schema is shown below with its type and property counts.
TestMtuMeasurements
boolean
Set true to measure MTU sizes on network from agents to the target.
SipServerTests
object
2 properties
TestCreatedDate
string
UTC created date (ISO date-time format).
MonitorType
string
Type of monitor
TestCreatedBy
string
User that created the test.
SipServerTestRequest
SipServerTest
1 required
TestLinks
object
A list of links that can be accessed to get more information
2 properties
AlertType
string
Type of alert being triggered. In multi-layered tests, this value represents the layer the alert relates to. See [Alert Details](https://developer.cisco.com/do…
TestAgentRequest
object
2 properties1 required
TestPathTraceMode
string
Select inSession to perform the path trace within a TCP session.
TestInterval
integer
Interval between test runs in seconds.
TestLabel
object
3 properties
TestIpv6Policy
string
IP version policy. Overrides the IPv6 policy configured at the agent level.
TestBgpMonitors
array
Contains list of enabled BGP monitors.
SelfLinks
object
A links object containing the self link.
1 property
SharedWithAccount
object
2 properties
SipTestProtocol
string
Transport layer for SIP communication.
Coordinates
object
Geographic coordinates for agent location.
2 properties
TestTag
object
3 properties
AlertRule
object
13 properties
BaseRequest
object
4 properties
TestSipAuthUser
string
Username for authentication with SIP server.
AgentResponse
UnexpandedSipServerTest
SipServerInstantTest
SimpleAgent
object
AlertRoundsViolationMode
string
exact requires the same agents to meet the threshold in consecutive rounds. auto is only enabled for CEA and Endpoint Scheduled test rules. The default is any.
UnexpandedInstantTest
object
11 properties
TestType
string
This is a read only value, as test type is implicit in the test creation url.
UnauthorizedError
object
2 properties
InstantTest
TestResults
array
Reference to the test results.
TestAgentsResponse
array
Contains list of agents.
TestSipRegistrar
string
SIP server to be tested, specified by domain name or IP address.
TestRandomizedStartTime
boolean
Indicates whether agents should randomize the start time in each test round.
TestBgpMeasurements
boolean
Set to true to enable bgp measurements.
TestNetworkMeasurements
boolean
Enable or disable network measurements. Set to true to enable or false to disable network measurements.
AlertDirection
string
Direction for applicable alert types (eg. path trace, End-to-End (Agent) etc.)
BaseTest
TestSipUser
string
Username for SIP registration, should be unique within a ThousandEyes account group.
UnexpandedTest
object
3 properties
Monitor
object
6 properties
ExpandTestOptions
string
TestAgentsRequest
array
Contains list of Agent IDs (get agentId from /agents endpoint).
TestRequest
1 required
TestPort
integer
Target port.
TestLabels
array
Labels to which the test is assigned. This field is not returned for Instant Tests.
SipServerProperties
object
13 properties2 required
RuleId
string
Unique ID of the rule.
TestFixedPacketRate
integer
Sets packets rate sent to measure the network in packets per second.
TestPassword
string
Password for Basic/NTLM authentication.
Enabled
boolean
Test is enabled.
TestMonitorsProperties
object
3 properties
Error
object
5 properties
AgentBase
object
3 properties
TestSipCredentials
object
6 properties1 required
TestProbeMode
string
Probe mode used by network test, only valid when the protocol is set to TCP.
TestTags
array
Tags assigned to the test. Returned only when expand=tag is specified. This field is not returned for Instant Tests. For more information, see /tags.
CloudEnterpriseAgentType
string
Type of the agent.
TestSelfLink
ValidationError
object
Severity
string
The severity of the alert.
TestNumPathTraces
integer
Number of path traces executed by the agent.
MonitorsRequest
object
1 property
TestUsePublicBgp
boolean
Indicate if all available public BGP monitors should be used, when ommited defaults to bgpMeasurements value.
ValidationErrorItem
object
3 properties
SipServerTestResponse
SensitivityLevel
string
Used when roundsViolatingMode is set to auto. The default is medium. Higher sensitivity increases the likelihood of triggering alerts.
TestSharedAccounts
array
Link
object
A hyperlink from the containing resource to a URI.
8 properties1 required
NetworkProviderInfo
object
Information about the network provider that owns the agent's public IP prefix.
3 properties
NetworkProviderType
string
Classification of the agent's network provider.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of ThousandEyes SIP Server Tests 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.
