Consent Manager

  • Your Privacy

  • Strictly Necessary Cookies

  • Performance Cookies

  • Targeting Cookies

  • Functional Cookies

Your Privacy

When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer. For more information on the information we collect and how we use it see the Website Privacy Statement.

Strictly Necessary Cookies

Always Active

These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.

Performance Cookies

Off On

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.

Targeting Cookies

Off On

These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.

Functional Cookies

These cookies enable the website to provide enhanced functionality and personalization. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

Your Privacy [`dialog closed`]

By continuing to use our website, you acknowledge the use of cookies. Privacy Statement | Change Settings

Cookies allow us to optimise your use of our website. We also use third-party cookies for advertising and analytics. Please read our Privacy Statement and Website Privacy Statement for more information on how we use cookies.

DEVELOPER REFERENCE

Search Results

×Clear
  • Overview

    • Welcome
    • Authentication
    • Account group context
    • Response formats
    • Time ranges
    • Response status codes
    • Rate limits
    • Pagination
    • Change policy
    • API change summary
  • Instant tests

    • Instant test
    • Instant test rerun
  • Tests

    • Test list
    • Test list by type
    • Test details
    • Test metadata
    • Creating a test
    • Updating a test
    • Deleting a test
    • Saved events
    • Path vis interface group list
    • Creating path vis interface group
    • Updating path vis interface group
    • Deleting path vis interface group
  • Test Data

    • (Network) End-to-End metrics
    • (Network) Path visualization
    • (Network) Detailed path trace
    • (Network) BGP metrics
    • (Network) BGP route information
    • (Web) HTTP server
    • (Web) Page load
    • (Web) Page load component detail
    • (Web) Web Transactions
    • (Web) Web Transaction detail
    • (Web) Web Transaction component detail
    • (Web) FTP server
    • (DNS) Domain trace
    • (DNS) Server metrics
    • (DNS) DNSSEC
    • (Voice) SIP server
    • (Voice) RTP stream
  • Credentials

    • Credential list
    • Credential details
    • Creating a credential
    • Updating a credential
    • Deleting a credential
  • Endpoint Agents

    • Listing all agents
    • Getting an agent by id
    • Updating an agent
    • Enabling an agent
    • Disabling an agent
    • Transferring an agent
    • Deleting an agent
  • Endpoint Data

    • Endpoint user session list
    • Endpoint user session details
    • Endpoint web pages list
    • Endpoint web page details
    • Endpoint network sessions list
    • Endpoint network topology list
    • Endpoint network topology details
    • Endpoint data filtering
    • Endpoint networks
  • Endpoint Tests

    • Scheduled Test List
    • Scheduled Test List by Type
    • Scheduled Test Details
    • Scheduled Test Metadata
    • Creating a Scheduled Test
    • Automated Session Test List
    • Automated Session Test Details
    • Automated Session Test Metadata
    • Creating an Automated Session Test
  • Endpoint Instant Tests

    • Creating instant test
    • Rerunning instant test
  • Endpoint Test Data

    • Scheduled Tests (Network) End-to-End metrics
    • Scheduled Tests (Network) Path visualization
    • Scheduled Tests (Network) Detailed path trace
    • Scheduled Tests (Web) HTTP server
    • Automated Session Tests End-to-End metrics
    • Automated Session Tests Path visualization
    • Automated Session Tests Detailed path trace
  • Snapshots

    • Create a new snapshot
  • Agents & Monitors

    • Agent list
    • Agent detail
    • Updating an agent
    • Deleting an Agent
    • Agent cluster - Creating
    • Agent cluster - Adding members
    • Agent cluster - Removing members
    • Agent cluster - Converting to an agent
    • BGP Monitor list
    • Agent Notification Rules
    • Agent Notification Rule Detail
    • Agent Proxies List
  • Alerts & Notifications

    • Active alerts
    • Alert detail
    • Alert rules
    • Alert rule detail
    • Alert rule metadata
    • Creating an alert rule
    • Updating an alert rule
    • Deleting an alert rule
    • Alert notification integrations
    • Alert suppression windows
    • Alert suppression window detail
    • Creating an alert suppression window
    • Updating an alert suppression window
    • Deleting an alert suppression window
    • Creating an advanced Alert Rule
  • Labels

    • Labels list
    • Labels list by type
    • Label details
    • Label details (by label type)
    • Creating a label
    • Updating a label
    • Deleting a label
  • Reports

    • Reports list
    • Report detail
    • Report data
    • Deleting a report
    • Report snapshots list
    • Report snapshot detail
    • Report snapshot data
    • Deleting a report snapshot
  • Dashboards

    • Dashboards list
    • Dashboards detail
    • Dashboard data
    • Deleting a dashboard
    • Dashboard snapshots list
    • Dashboards snapshot detail
    • Dashboard snapshot data
    • Deleting a dashboard snapshot
  • Administrative endpoints

    • Account group list
    • Account group detail
    • Creating an account group
    • Updating an account group
    • Deleting an account group
    • User list
    • User detail
    • Adding a user
    • Updating a user
    • Deleting a user
    • Role list
    • Role detail
    • Creating a role
    • Updating a role
    • Permission list
    • Activity log
    • Obtaining usage quota
    • Updating usage quotas
  • Usage

    • Obtaining usage details
    • Usage metadata

  • Showing APIv6  |  APIv7 (preview)

  • Product Documentation
  • Customer Success Center
  • Public GitHub Repository

Try ThousandEyes Now! Sign Up

Credentials

GET /v6/credentials Credential list

Returns a list of all credentials configured in ThousandEyes.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information.

Request

  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
credentialIdintegern/aunique ID of the credential
namestringn/aThe name of the credential
valuestringn/aThe value of the credential that will be encrypted (if the user has permission to read sensitive data)
apiLinksobjectn/aThe reference to this credential

Example

$ curl https://api.thousandeyes.com/v6/credentials.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Date: Fri, 15 Nov 2019 19:17:46 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Vary: Accept-Encoding X-Server-Name: 8xb13 Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 211 X-Organization-Rate-Limit-Reset: 1573845480 Strict-Transport-Security: max-age=15724800; includeSubDomains Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff

Body

{ "credentials": [ { "credentialId": 405, "name": "Example Credential 1", "apiLinks": [ { "rel": "self", "href": "https://api.thousandeyes.com/v6/credentials/405" } ] } ] }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/credentials/{credentialId} Credential details

Returns details for a credential, including test name, reference & value (value is only visible if the user has View sensitive data in web transaction permission). The user should have access to this credential by sharing the same account and must have the View tests permission.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information.

Request

  • {credentialId} the ID of the credential you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
credentialIdintegern/aunique ID of the credential
namestringn/aThe name of the credential
valuestringn/aThe value of the credential that will be encrypted (if the user has permission to read sensitive data)
apiLinksobjectn/aThe reference to this credential

Example

$ curl https://api.thousandeyes.com/v6/credentials/405.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Date: Fri, 15 Nov 2019 19:36:19 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Vary: Accept-Encoding X-Server-Name: f72ql Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 228 X-Organization-Rate-Limit-Reset: 1573846620 Strict-Transport-Security: max-age=15724800; includeSubDomains Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff

Body

{ "credentials": [ { "credentialId": 405, "name": "Example Credential 1", "apiLinks": [ { "rel": "self", "href": "https://api.thousandeyes.com/v6/credentials/405" } ] } ] }

For more information on our HTTP response status codes, see the response status codes documentation.

POST /v6/credentials/new Creating a credential

Creates a new credential in ThousandEyes, based on properties provided in the POST data. In order to create a new credential, the user attempting the creation must have permission to create tests.

Optional (Querystring) Parameters

  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information.

Request

  • Request body should contain both a name and value to be set during creation.
FieldData TypeUnitsNotes
namestringn/aThe name of the credential
valuestringn/aThe value of the credential that will be encrypted (if the user has permission to read sensitive data)

Response

If a credential is successfully created, an HTTP/201 CREATED response will be returned, and the credential definition (without its value) will be returned.

FieldData TypeUnitsNotes
credentialIdintegern/aunique ID of the credential
namestringn/aThe name of the credential
apiLinksobjectn/aThe reference to this credential

Example

The following example is presented for documentation and reference purposes only.

$ curl -i https://api.thousandeyes.com/v6/credentials/new.json \ -d '{ "name": "new_api_credential", "value": "secret p@ssword" }' \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 201 CREATED Date: Fri, 15 Nov 2019 19:46:31 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Vary: Accept-Encoding X-Server-Name: 8xb13 Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1573846620 Strict-Transport-Security: max-age=15724800; includeSubDomains Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff

Body

{ "credentials": [ { "credentialId": 405, "name": "Example Credential 1", "apiLinks": [ { "rel": "self", "href": "https://api.thousandeyes.com/v6/credentials/405" } ] } ] }

For more information on our HTTP response status codes, see the response status codes documentation.

POST /v6/credentials/{credentialId}/update Updating a credential

Updates a credential in ThousandEyes, based on properties provided in the POST data. In order to update a credential, the user attempting the creation must have permission to update tests & should have access to the credential (same account)

Optional (Querystring) Parameters

  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information.

Request

  • {credentialId} corresponds to the unique ID of the credential to be updated, obtained through the /credentials endpoint
  • Request body should contain fields to be set during update.
FieldData TypeUnitsNotes
namestringn/aThe name of the credential
valuestringn/aThe value of the credential that will be encrypted (if the user has permission to read sensitive data)

Response

If a credential is successfully edited, an HTTP/200 OK response will be returned, and the credential definition (without its value) will be returned.

FieldData TypeUnitsNotes
credentialIdintegern/aunique ID of the credential
namestringn/aThe name of the credential
apiLinksobjectn/aThe reference to this credential

Example

The following example is presented for documentation and reference purposes only.

$ curl -i https://api.thousandeyes.com/v6/credentials/405/update.json \ -d '{ "value":"updated password" }' \ -H "Content-Type: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Mon, 09 May 2016 16:04:24 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 227 X-Organization-Rate-Limit-Reset: 1492608660 Strict-Transport-Security: max-age=31536000 X-Server-Name: 1-2

Body

{ "credentials": [ { "credentialId": 405, "name": "Example Credential 1", "apiLinks": [ { "rel": "self", "href": "https://api.thousandeyes.com/v6/credentials/405" } ] } ] }

For more information on our HTTP response status codes, see the response status codes documentation.

POST /v6/credentials/{credentialId}/delete Deleting a credential

Deletes the specified credential in ThousandEyes, based on the credentialID provided in the API request.

Optional (Querystring) Parameters

  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information.

Request

  • The request body must be provided, but should be empty

Response

If a credential is successfully deleted, an HTTP/204 NO CONTENT response will be returned, and an empty JSON response will be in the body of the response.

Example

The following example is presented for documentation and reference purposes only.

$ curl -i https://api.thousandeyes.com/v6/credentials/405/delete.json \ -d '' \ -H "Content-Type: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 204 No Content Date: Fri, 15 Nov 2019 20:24:33 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Server-Name: fjxcv Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 236 X-Organization-Rate-Limit-Reset: 1573849500 Strict-Transport-Security: max-age=15724800; includeSubDomains Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff

Body

  • The body of a delete response will be empty.

For more information on our HTTP response status codes, see the response status codes documentation.

© 2023 ThousandEyes. All rights reserved.