Endpoint agents

GET /v6/endpoint-agents Listing all agents

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

Request

  • There is no request body for this request.

Optional (Querystring) Parameters

  • 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

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.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

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.stg.thousandeyes.com/v6/endpoint-agents?page=2", "current": 1 }, "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 }, { "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 }, ... ] } }

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.

Request

  • There is no request body for this request.

Response

Returns information about the agent with a given id. See the below example for the details.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

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}/enable Enabling an agent

Enables an agent with a given id.

Request

  • There is no request body for this request.

Response

Sends back the enabled agent details. See the example for the details.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba/enable.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

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.

Request

  • There is no request body for this request.

Response

Sends back the disabled agent details. See the below example for the details.

Example

$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba/disable.json \ -u noreply@thousandeyes.com:g351mw5xqhvkmh1vq6zfm51c62wyzib2

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.