ThousandEyes Templates API
The Templates API from ThousandEyes — 4 operation(s) for templates.
ThousandEyes Templates API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 8 operations across 4 paths, and defines 140 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
4 paths
140 schemas
1 DELETE3 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ThousandEyes Templates 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 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Templates 8
POST
/templates
Create template
GET
/templates
List templates
GET
/templates/{id}
Get template
PUT
/templates/{id}
Update template
DELETE
/templates/{id}
Delete template
POST
/templates/{id}/deploy
Deploy template
GET
/templates/{id}/sharing-settings
Get template sharing settings
PUT
/templates/{id}/sharing-settings
Update template sharing settings
Schemas 140
The contract defines 140 schemas that model the data the API accepts and returns. The most detailed are EndpointHttpTestConfigTemplate (20 properties), Template (18 properties), HttpServerTestBaseTemplate (15 properties), EndpointTestConfigTemplate (13 properties). Each schema is shown below with its type and property counts.
TagIdListTemplate
array
A list of tag IDs identifying tags to be assigned.
DnsServersTemplate
array
DNS Servers to target
EndpointTestConfigProtocolTemplate
string
The protocol to use for ping/traceroute tests.
VoiceTestTemplate
HttpServerTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
TagAssignmentTemplate
object
Identifies an object to assign a tag to.
2 properties
2 required
DnsTraceTestTemplate
SharingScope
string
The scope of the template sharing. The accepted values are: - default: The template is visible only within the account group that owns it. - organization: The…
SchemaVersionConfig
object
Configuration for resource schema versions. Specifies which schema version (v6 or v7) to use for each resource type in a template. If a field is omitted, the d…
2 properties
CertificationLevel
string
The certification level of the Template. The accepted values are: - user: User created template; not verified by ThousandEyes - thousandeyes: Created by Thousa…
VoiceIntervalTemplate
integer
Voice test interval in seconds.
AgentToAgentTestTemplate
ResourceInclusion
string
The deployment inclusion configuration for the asset.
EndpointAuthTypeTemplate
The authentication type.
UserInputValue
A user input value. The type of object depends on the user input type field.
EndpointTestTypeTemplate
The type of Endpoint scheduled test. Possible values are: - Network - endpoint network test - Http - endpoint http test
AlertRulesSchemaVersion
string
Schema version for alert rule resources.
TemplateGroupingType
string
The type of resources included in the grouping. Supported types are Tests and User Inputs. Grouped tests are displayed under a shared title in the template tes…
FilterContextDataSourceTemplate
string
Type of data source for dashboard global filter.
AlertRuleSeverityTemplate
string
SslVersionIdTemplate
integer
The SSL Version; 0 for auto, 3 for SSLv3, 4 for TLS v1.0, 5 for TLS v1.1, 6 for TLS v1.2.
CustomHeadersTemplate
object
Custom headers to use in HTTP request.
3 properties
HttpVersionTemplate
integer
The HTTP Version; 2 for default (prefer HTTP/2), 1 for HTTP/1.1 only.
PageLoadTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
TargetSipCredentialsTemplate
object
5 properties
2 required
TargetServerTemplate
Target host name or IP address. Example "app.thousandeyes.com".
LabelTypeTemplate
string
The type of label. Acceptable values are: - tests - A Label that can be assigned to CEA/Synthetic tests - endpointtests - A Label that can be assigned to Endpo…
DnsServerTestTemplate
TransactionTestTemplate
AuthTypeTestTemplate
string
Authentication type to use when establishing connection.
TemplateResponseBase
object
2 properties
LabelConfigurationTemplate
object
A label object that is compatible with [ThousandEyes V6 API](https://developer.cisco.com/docs/thousandeyes/v6/create-a-label/request). All field values can be…
4 properties
1 required
TestInterval
integer
Interval between test runs in seconds.
Templates
object
1 property
ProbeModeTemplate
string
The probe mode used by the end-to-end Network test. Only valid if the protocol is set to TCP. Defaults to AUTO.
TagAssignmentObjectType
string
The type of object that can be assigned a tag.
SipServerTestBaseTemplate
object
5 properties
3 required
AgentToServerTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
DeploymentStrategy
string
The deployment strategy to apply to the asset.
BgpTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
SelfLinks
object
A links object containing the self link.
1 property
WidgetMeasureType
string
Determines how to aggregate the the metric.
TemplateModule
string
A ThousandEyes module this template belongs to. Regular users can only set to default.
EndpointTestTypeOptionsTemplate
string
TestIdTemplate
object
Test identified by the test's ID.
1 property
TemplateResponse
TransactionTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
PageLoadTestTemplate
WidgetFilters
object
(Optional) Specifies the filters applied to the widget. When present, the filters property displays. Each filter object has two properties: filterProperty and…
TemplateGrouping
object
Represents a grouping of different template resources for display purposes in the UI. This grouping does not affect template deployment.
5 properties
3 required
TagAssignmentListTemplate
array
A list of objects to assign a tag to.
TransactionTestBaseTemplate
object
5 properties
5 required
SharingSettings
object
The Template to change the sharing settings for.
1 property
1 required
AgentToAgentTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
EndpointAuthTypeEnumTemplate
string
The authentication type.
TagObjectTypeTemplate
string
The type of object associated with the tag. Supported values for templates are: - test - CEA/Synthetic tests - endpoint-test - Endpoint tests - connected-devic…
TestsSchemaVersion
string
Schema version for test resources.
SipServerTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
LegacyDurationUnit
string
Timespan unit.
TemplateLink
EndpointMonitoringSettingsTypeTemplate
string
The strategy to use for selecting Endpoint agents to include in a test. Possible values are: - SPECIFICAGENTS - use agentIds to select a specific set of agents…
BrowserTestBaseTemplate
object
6 properties
AlertRuleConfigurationTemplate
object
Alert Rule configuration. See [ThousandEyes v6 API spec](https://developer.cisco.com/docs/thousandeyes/v6/metadata/alert-rule-metadata) for schema details.
8 properties
5 required
VoiceTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
AccessType
string
The access level of the tag. The access level determines the label's visibility in the UI and the permissions required to modify it. Accepted values are: all:…
TemplatesResponse
DnsTargetDomainTemplate
Specifies the target DNS host name for the test, suffixed by the record type (e.g., www.thousandeyes.com CNAME). If no record type is specified, the test will…
UnauthorizedError
object
2 properties
ApiWidgetMeasure
object
Determines how to aggregate the the metric.
2 properties
DnsServerTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
DashboardMetricDirection
string
Direction of agent to agent metric.
WidgetType
string
Type of the Widget
StringTemplate
TemplateIcon
string
Icon that will be used when displaying the template in UI. If none supplied, will display thousandeyes icon. Supported values include: - api - custom - server…
AgentAssignmentTemplate
object
1 property
BgpTestTemplate
object
9 properties
3 required
SharingSettingsLinks
object
A list of links that can be accessed to get more information.
2 properties
EndpointAlertRuleConfigTemplate
object
Alert rules to associate with the test.
1 property
1 required
SipProtocolTemplate
The SIP protocol to use for SIP transport layer; defaults to TCP. When creating or updating a SIP test, set this field as part of the targetSipCredentials fiel…
SipRegistrarTemplate
The target SIP server, without port.
AlertRuleTypeTemplate
string
AgentToServerTestTemplate
PathTraceModeTemplate
string
The path trace mode. Choose inSession to perform the path trace within a TCP session. Defaults to classic for network path discovery.
DashboardFilterContextTemplate
object
List of dashboard filter contexts.
2 properties
2 required
SipServerTestTemplate
TestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
EndpointAgentSelectionConfigTemplate
object
Configuration that will be used to determine what Endpoint Agents to assign to a test.
4 properties
1 required
DashboardConfigurationTemplate
object
Configuration of a dashboard that will be created when template is deployed.
5 properties
NumberTemplate
DashboardFilterConfigurationTemplate
object
A dashboard filter object. See [V7 API Documentation](https://developer.cisco.com/docs/thousandeyes/v7/list-dashboard-filters/) for more details on dashboard f…
3 properties
TagConfigurationTemplate
object
A tag configuration object for use in ThousandEyes Templates. Tags use a key/value model to provide meaningful metadata to ThousandEyes assets (such as tests,…
6 properties
4 required
SharingSettingsLink
HttpServerTestBaseTemplate
object
15 properties
VisualMode
string
Visual mode in the UI. Either full or half the width of the window.
PageLoadTestBaseTemplate
object
4 properties
4 required
MetricGroup
string
Metric group of widget as it appears in the UI. Note: may not be required in some cases.
EndpointTestConfigTemplate
object
Configuration settings for a ThousandEyes Endpoint test. All test fields can be templated with Handlebars expression unless otherwise noted.
13 properties
6 required
Error
object
5 properties
DeployTemplate
object
3 properties
DashboardMetric
string
Indicates the specific metric in the report, determined by the layer, test type, and metric values.
TestConfigurationTemplate
A ThousandEyes CEA (Synthetic) test configuration that is compatible with [ThousandEyes V6 API](https://developer.cisco.com/docs/thousandeyes/v6/tests-metadata…
ApiDataSourceFilterTemplate
object
List of different filter properties for a single datasource.
3 properties
3 required
EndpointHttpTestConfigTemplate
object
HTTP test settings.
20 properties
6 required
EndpointTestCategoryOptionsTemplate
string
EndpointTestIntervalTemplate
integer
How often the test will run, in seconds.
ValidationError
object
TestBaseTemplate
object
6 properties
3 required
EndpointNetworkTestConfigTemplate
object
Network test settings.
7 properties
7 required
AgentToAgentTestDirectionTemplate
string
Direction of the test (affects how results are shown). Defaults to TOTARGET.
Template
object
The template to create or update.
18 properties
1 required
UserInputType
string
The type of user input. This defines the value the user can provide as well as the UI component displayed when redering User Inputs. The type is used to valida…
LabelAssignmentTemplate
object
Label to assign to a test, identified by the ID (groupId).
1 property
NetworkTestBaseTemplate
object
9 properties
TransportProtocolTemplate
string
The network transport protocol to use for the test.
ValidationErrorItem
object
3 properties
UserInputAllowedValue
object
The list of values that the user is allowed to use as inputs.
2 properties
EndpointTcpProbeModeTemplate
string
Used in TCP mode only.
DashboardRefreshRateTemplate
string
The refresh rate of the dashboard.
TagIdTemplate
A tag ID, typically a Handlebars reference to a tag defined in the template.
NumPathTracesTemplate
integer
Number of path trace probes to run. Defaults to 3, with a range of 3 to 10.
PageLoadStrategyTemplate
string
DashboardFilterListTemplate
array
List of filters to be applied to a dashboard.
TransactionScriptTemplate
Transaction script for transaction test. Must be a JavaScript string with escaped quotes.
DashboardWidgetTemplate
object
Configuration of a dashboard widget.
10 properties
SharingSettingsResponse
EndpointServerConfigTemplate
object
Target server information.
2 properties
2 required
EndpointTestLabelListTemplate
array
A list of label IDs identifying label to be assigned.
BooleanNumber
integer
EndpointIpVersionTemplate
string
IP version the test should use for network tests.
TagConfigurationOverride
object
Partial override for a tag configuration defined in a template. All fields are optional; only the fields you specify will override the corresponding values in…
6 properties
EndpointGenericConfigTemplate
object
Settings common to HTTP and Network tests.
2 properties
2 required
Link
object
A hyperlink from the containing resource to a URI.
8 properties
1 required
DnsTraceTestTypeTemplate
string
The type of test. Cannot be templated with Handlebars.
HttpServerTestTemplate
ApiDurationTemplate
object
Specifies a fixed timespan for data aggregation.
2 properties
PortTemplate
The network port.
HandlebarsExpression
string
A valid Handlebars expression. Can reference user inputs, such as {{name}}, or fields of other assets defined in the template. {{userInputs. }} - resolves to t…
DnsServerEntryTemplate
object
Server host name (FQDN). Example "www.example.com".
1 property
1 required
UserInput
object
A user input is a value that the user must provide when deploying a template. User Input values are provided by the user in the UI under the Global Settings se…
6 properties
2 required
EndpointTestCategoryTemplate
Whether the test is SCHEDULEDTEST or DYNAMICAPPTEST.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ThousandEyes 12
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
#Templates
Where this information came from
This is an independent, third-party profile of ThousandEyes Templates 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.