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
  • 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

Endpoint agents

GET /v6/endpoint-agents Listing all agents

Returns a list of all endpoint agents in a given account group.

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
  • deleted=true|false specifies if deleted agents should be returned too. By default it is false - only non-deleted agents are returned
  • agentName={agent_name} returns only agents with a given name
  • computerName={computer_name} returns only agents with a given computer name

Request

  • There is no request body for this request.

Response

Sends back an array of endpoint agents. Account groups with a larger number of agents will have the response paginated - details about response pagination can be found here.

Each endpoint agent consists of the following fields:

FieldData TypeNotes
agentIdstringunique ID of the Endpoint agent
agentNamestringdisplay name of the agent
computerNamestringdisplay name of the computer
osVersionstringversion of the OS computer is running
kernelVersionstringversion of the kernel computer is running
manufacturerstringcomputer hardware manufacturer
modelstringcomputer hardware model
totalMemorystringtotal memory (RAM) of the computer
lastSeendatetimelast time when agent checked-in
statusstringstatus of the Endpoint agent in ThousandEyes, set to “enabled” or “disabled”
deletedboolset to true if the Endpoint agent has been deleted, false otherwise
versionstringversion of the Endpoint agent
createdTimedatetimedate and time when the Endpoint agent was installed
numberOfClientsintegerthe number of user accounts associated with the machine where the Endpoint agent is installed
publicIPstringpublic IP of the Endpoint agent used for the most recent check-in
locationobjectlocation of the Endpoint agent resolved during last check-in, see location object below for details
clientsarraythe user accounts on the machine where the Endpoint agent is installed, see client below for details
agentTypestringtype of the Endpoint agent, valid values are “enterprise” for Endpoint agent Enterprise, and “enterprise-pulse” for an Endpoint agent Pulse
proxyIdintegerproxyId if the agent is configured to use a proxy server
vpnProfilesarraylist of VPNs that the Endpoint Agent detected in its last checkin. See vpnProfile below for details
networkInterfaceProfilesarraylist of network interfaces. See interfaceProfile below for details

Each client corresponds to one OS account and consists of the following fields:

FieldData TypeNotes
browserExtensionsarrayif installed, details about endpoint browser extensions, see browserExtensions object below
userProfileobjectuser profile containing a user name. The name is extracted from operating system account when endpoint agent is installed

location object:

FieldData TypeNotes
latitudedoubleapproximate GPS latitude of the Endpoint agent
longitudedoubleapproximate GPS longitude of the Endpoint agent
locationNamestringgeographic name of the Endpoint agent’s location

browserExtensions object:

FieldData TypeNotes
browserstringname of the browser where the extension is installed, “CHROME,” “EDGE” or “IE”
profilestringname of the browser profile where the extension is installed
versionstringendpoint agent browser extension version number
enabledboolflag indicating if the extension is “disabled” or “enabled” in the web browser
activeboolflag indicating if there is communication between the extension and ThousandEyes portal
errorstringany errors encountered while getting extension status

vpnProfile object:

FieldData TypeNotes
interfaceNamestringinterface name associated with interfaceProfile. See interfaceProfile object below
vpnTypestringname of the VPN provider. For example, “CiscoAnyConnect” or “ZscalerInternet”
vpnGatewayAddressstringIP address of the VPN gateway
vpnClientAddressesarraylist of private IP addresses that the VPN server assigned to the device
vpnClientNetworkRangearraylist of private networks that the VPN server assigned to the device

interfaceProfile object:

FieldData TypeNotes
interfaceNamestringname of the network interface
addressProfilesarrayan array of address profiles. See addressProfile object below
hardwareTypeenumname of hardware type - WIRELESS, ETHERNET, MODEM, VIRTUAL, OTHER or UNKNOWN.
ethernetProfileobjectthis field is present only if the hardware type of this interface is determined to be ETHERNET. See ethernetProfile object below
wirelessProfileobjectthis field is present only if the hardware type of this interface is determined to be WIRELESS. See wirelessProfile object below

addressProfile object:

FieldData TypeNotes
addressTypeenumthe address type. Can be UNIQUE_LOCAL (an address that is routable only in the scope of a private network) or UNIQUE_GLOBAL (an address that is globally routable)
ipAddressstringIP address of this interface in the network it’s currently connected to
prefixLengthstringthe number of bits representing the network part of ipAddress
gatewaystringdefault gateway for this interface.
routerHardwareAddressstringrouter’s MAC address resolved from an ARP request

ethernetProfile object:

FieldData TypeNotes
linkSpeedintegerlink speed in Mbps

wirelessProfile object:

FieldData TypeNotes
bssidstringbasic service set identifier (MAC)
ssidstringservice set identifier (name)
rssiintegerreceived signal strength indicator
channelintegerwireless network channel
phyModestringphysical mode, for example 802.11ac

Example

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

Header

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "pages": { "next": "https://api.thousandeyes.com/v6/endpoint-agents?pageId=cd9cf945-f66f-4945-b5fe-f7a9a2a97896" }, "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "test-agent-1", "computerName": "windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "status": "enabled", "deleted": false, "createdTime": "2017-06-29 22:05:36", "lastSeen": "2020-02-20 23:56:43", "version": "0.191.0", "publicIP": "13.227.74.44", "location": { "latitude": 51.51130676269531, "longitude": -0.271392822265625, "locationName": "London, England, UK" }, "clients": [ { "userProfile": { "userName": "pzielinski" }, "browserExtensions": [ { "browser": "CHROME", "profile": "Profile 1", "version": "1.11.0", "installed": true, "enabled": true, "active": true } ] } ], "totalMemory": "16384 MB", "agentType": "enterprise", "vpnProfiles": [ { "vpnGatewayAddress": "18.64.79.52", "vpnType": "CiscoAnyConnect", "vpnClientAddresses": ["10.136.56.58"], "vpnClientNetworkRange": ["10.136.32.0/19"] } ] }, { "agentId": "36ebc26d-19fe-443d-a9bd-cf4ae8f021f0", "agentName": "test-agent-2", "computerName": "mac os", "osVersion": "Version 10.15.2 (Build 19C57)", "kernelVersion": "Darwin 19.2.0", "manufacturer": "Apple, Inc.", "model": "MacBookAir7,2", "status": "enabled", "deleted": false, "createdTime": "2017-06-29 22:05:36", "lastSeen": "2020-02-20 23:56:43", "version": "0.191.0", "publicIP": "13.227.74.43", "location": { "latitude": 51.51130676269531, "longitude": -0.271392822265625, "locationName": "London, England, UK" }, "clients": [ { "userProfile": { "userName": "pzielinski" }, "browserExtensions": [ { "browser": "CHROME", "profile": "Profile 1", "version": "1.11.0", "installed": true, "enabled": true, "active": true } ] } ], "totalMemory": "16384 MB", "agentType": "enterprise", "vpnProfiles": [ { "vpnGatewayAddress": "18.64.79.52", "vpnType": "CiscoAnyConnect", "vpnClientAddresses": ["10.136.56.58"], "vpnClientNetworkRange": ["10.136.32.0/19"] } ], "networkInterfaceProfiles": [ { "interfaceName": "en0", "addressProfiles": [ { "addressType": "UNIQUE_LOCAL", "ipAddress": "192.168.1.64", "prefixLength": 24, "gateway": "192.168.1.254", "routerHardwareAddress": "5c:b1:3e:46:1c:84" } ], "hardwareType": "WIRELESS", "wirelessProfile": { "bssid": "5c:b1:3e:46:1c:87", "ssid": "PLUSNET-2CNJ-5ghz", "rssi": -56, "channel": 48, "phyMode": "802.11ac" } }, { "interfaceName": "utun4", "addressProfiles": [ { "addressType": "UNIQUE_GLOBAL", "ipAddress": "2a01:4b00:bd04:d000:1c63:3302:4092:220d", "prefixLength": 64, "gateway": "fe80::6620:9fff:fe11:58f6", "routerHardwareAddress": "64:20:9f:11:58:f6" }, ], "hardwareType": "VIRTUAL" }] }, }, ... ] }

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

GET /v6/endpoint-agents/{agent_id} Getting an agent by id

Returns information about the agent with a given id.

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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • There is no request body for this request

Response

Returns information about the agent with a given id. See Listing all agents for details of each field.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "test agent 1", "computerName": "Windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "lastSeen": "2020-02-20 23:56:43", "status": "enabled", "deleted": false, "version": "0.191.0", "createdTime": "2017-06-29 22:05:36", "numberOfClients": 3, "publicIP": "13.227.74.44", "location": { "latitude": 51.51130676269531, "longitude": -0.271392822265625, "locationName": "London, England, UK" }, "clients": [ { "userProfile": { "userName": "pzielinski" }, "browserExtensions": [ { "browser": "CHROME", "profile": "Profile 1", "version": "1.11.0", "installed": true, "enabled": true, "active": true } ] } ], "totalMemory": "16384 MB", "agentType": "enterprise", "vpnProfiles": [ { "vpnGatewayAddress": "18.64.79.52", "vpnType": "CiscoAnyConnect", "vpnClientAddresses": [ "10.136.56.58" ], "vpnClientNetworkRange": [ "10.136.32.0/19" ] } ], "networkInterfaceProfiles": [ { "interfaceName": "en0", "addressProfiles": [ { "addressType": "UNIQUE_LOCAL", "ipAddress": "192.168.1.64", "prefixLength": 24, "gateway": "192.168.1.254", "routerHardwareAddress": "5c:b1:3e:46:1c:84" } ], "hardwareType": "WIRELESS", "wirelessProfile": { "bssid": "5c:b1:3e:46:1c:87", "ssid": "PLUSNET-2CNJ-5ghz", "rssi": -56, "channel": 48, "phyMode": "802.11ac" } }, { "interfaceName": "utun4", "addressProfiles": [ { "addressType": "UNIQUE_GLOBAL", "ipAddress": "2a01:4b00:bd04:d000:1c63:3302:4092:220d", "prefixLength": 64, "gateway": "fe80::6620:9fff:fe11:58f6", "routerHardwareAddress": "64:20:9f:11:58:f6" } ], "hardwareType": "VIRTUAL" } ] } ] }

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

POST /v6/endpoint-agents/{agent_id} Updating an agent

Updates a given agent with a new name.

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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • Currently the only request body supported is to change the Agent Name, as follows:

{ "newAgentName":"new name" }

Response

Returns information about the updated agent. See Listing all agents for details of each field.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba.json \ -d '{"newAgentName":"new name"}' \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Fri, 24 Apr 2020 15:59:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1587744000 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "new name", "computerName": "Windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "lastSeen": "2020-02-20 23:56:43", "status": "enabled", "deleted": false, "version": "0.191.0", "createdTime": "2017-06-29 22:05:36", "numberOfClients": 3, "publicIP": "13.227.74.44", "location": { "latitude": 51.51130676269531, "longitude": -0.271392822265625, "locationName": "London, England, UK" }, "clients": [ { "userProfile": { "userName": "pzielinski" }, "browserExtensions": [ { "browser": "CHROME", "profile": "Profile 1", "version": "1.11.0", "installed": true, "enabled": true, "active": true } ] } ], "totalMemory": "16384 MB", "agentType": "enterprise" } ] }

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

POST /v6/endpoint-agents/{agent_id}/enable Enabling an agent

Enables an agent with a given id.

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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • There is no request body for this request

Response

Sends back the enabled agent details. See Listing all agents for details of each field.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba/enable.json \ -d '' \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "test-agent-1", "computerName": "Windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "lastSeen": "2020-02-20 23:56:43", "status": "enabled", "deleted": false, "version": "0.191.0", "createdTime": "2017-06-29 22:05:36", "numberOfClients": 3 } ] }

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

POST /v6/endpoint-agents/{agent_id}/disable Disabling an agent

Disables an agent with a given id.

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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • There is no request body for this request

Response

Sends back the disabled agent details. See Listing all agents for details of each field.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba/disable.json \ -d '' \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "test-agent-1", "computerName": "Windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "lastSeen": "2020-02-20 23:56:43", "status": "disabled", "deleted": false, "version": "0.191.0", "createdTime": "2017-06-29 22:05:36", "numberOfClients": 3 } ] }

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

POST /v6/endpoint-agents/transfer Transferring an agent

Triggers a process of transferring a list of agents.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information

Request

The request’s body should contain a list of agents in CSV format with the following columns (comma delimited):

  • “machine_id” - agent id to be transferred
  • “from_aid” - account id where the agent needs to be transferred from
  • “to_aid” - account id where the agent needs to be transferred to

Example: machine_id,from_aid,to_aid 5d0764ac-7e42-4ec8-a0d4-39fc53edccba,111,222 5d0764ac-7e42-4ec8-a0d4-39fc53edccba,333,222

Sending the above body will transfer two agents (“5d0764ac-7e42-4ec8-a0d4-39fc53edccba”, “5d0764ac-7e42-4ec8-a0d4-39fc53edccba”) from accounts 111 and 333 into 222. The calling user needs to have ‘write’ permissions to all accounts submitted in the CSV.

The requests’ media type should be ‘text/csv’ or ‘text/plain’:

Content-Type: text/plain

Response

Returns an object confirming the number of agents to be transferred. Example:

{ "endpointAgentsTransfer": { "machineCount": 2 } }

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/transfer.json \ -d $'machine_id,from_aid,to_aid\n5d0764ac-7e42-4ec8-a0d4-39fc53edccba,111,222\n5d0764ac-7e42-4ec8-a0d4-39fc53edccba,333,222' \ -u {email}:{authToken} \ -H 'content-type: text/csv'

Header

HTTP/1.1 200 OK Server: nginx Date: Fri, 18 Mar 2021 15:59:50 GMT Content-Type: text/plain;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237EndpointAgentTransferServiceTest X-Organization-Rate-Limit-Reset: 1587744000 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgentsTransfer": { "machineCount": 2 } }

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

DELETE /v6/endpoint-agents/{agent_id} Deleting an agent

Deletes an agent with a given id.

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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • There is no request body for this request

Response

Returns the deleted agent details. See Listing all agents for details of each field.

Example

$ curl -X DELETE https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 17:03:50 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535216640 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAgents": [ { "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "agentName": "test-agent-1", "computerName": "Windows machine", "osVersion": "Microsoft Windows 10 Enterprise", "kernelVersion": "10.0.18362", "manufacturer": "LENOVO", "model": "20HR000FUS", "lastSeen": "2020-02-20 23:56:43", "status": "disabled", "deleted": true, "version": "0.191.0", "createdTime": "2017-06-29 22:05:36", "numberOfClients": 3 } ] }

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

© 2023 ThousandEyes. All rights reserved.