Endpoint Agents
Enable Agent
|
v6 |
v7 |
|
POST /v6/endpoint-agents/{agentId}/enable |
POST /v7/endpoint/agents/{agentId}/enable |
|
Request
Body |
|
|
|
|
|
Response
Body |
|
|
{
"endpointAgents": [ {
"agentId": "07ff166d-8309-4775-bbc5-e176dd94ec14",
"agentName": "test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)",
"kernelVersion": "Darwin 23.4.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17 16:42:55", "status": "enabled", "deleted": false, "version":
"1.195.0",
"createdTime": "2024-05-17 16:22:53",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" }, "clients": [ {
"userProfile": { "userName":
"test-user" },
"browserExtensions": [] } ],
"totalMemory": "32768 MB",
"agentType": "enterprise",
"networkInterfaceProfiles": [ {
"interfaceName": "en0",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.101",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "ETHERNET",
"ethernetProfile": {
"linkSpeed": 1000 } }, {
"interfaceName": "en1",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.208",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "WIRELESS",
"wirelessProfile": { "bssid":
"1c:8b:76:89:87:5d", "ssid":
"HomeNetwork", "rssi":
-64, "channel":
136, "phyMode":
"802.11ac" } } ],
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" } } ] } |
{ "id":
"07ff166d-8309-4775-bbc5-e176dd94ec14", "aid": "134813", "name":
"test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)", "platform": "mac",
"kernelVersion": "Darwin 23.4.0", "manufacturer": "Apple,
Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17T16:42:55.352Z", "status": "enabled", "deleted": false, "version": "1.195.0",
"createdAt": "2024-05-17T16:22:53.902Z",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude": 44.94441, "longitude": -93.09327,
"locationName": "Saint Paul, Minnesota, US" },
"totalMemory": "32768 MB",
"agentType": "endpoint",
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" },
"licenseType": "advantage",
"tcpDriverAvailable": true, "_links": { "self": {
"href":
"https://api.thousandeyes.com/v7/endpoint/agents/07ff166d-8309-4775-bbc5-e176dd94ec14" } } } |
|
Comments: |
|
Get Agent
|
v6 |
v7 |
|
GET /v6/endpoint-agents/{agentId} |
GET /v7/endpoint/agents/{agentId} |
|
Request
Body |
|
|
|
|
|
Response
Body |
|
|
{
"endpointAgents": [ {
"agentId": "07ff166d-8309-4775-bbc5-e176dd94ec14",
"agentName": "test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)",
"kernelVersion": "Darwin 23.4.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17 16:42:55", "status":
"enabled", "deleted": false, "version":
"1.195.0",
"createdTime": "2024-05-17 16:22:53",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" }, "clients": [ {
"userProfile": { "userName":
"test-user" },
"browserExtensions": [] } ],
"totalMemory": "32768 MB",
"agentType": "enterprise",
"networkInterfaceProfiles": [ {
"interfaceName": "en0",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.101",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "ETHERNET",
"ethernetProfile": {
"linkSpeed": 1000 } }, {
"interfaceName": "en1",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.208",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "WIRELESS",
"wirelessProfile": { "bssid":
"1c:8b:76:89:87:5d", "ssid":
"HomeNetwork", "rssi":
-64, "channel":
136, "phyMode":
"802.11ac" } } ],
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" } } ] } |
{ "id":
"07ff166d-8309-4775-bbc5-e176dd94ec14", "aid": "134813", "name":
"test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)", "platform": "mac",
"kernelVersion": "Darwin 23.4.0", "manufacturer": "Apple,
Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17T16:42:55.352Z", "status": "enabled", "deleted": false, "version": "1.195.0",
"createdAt": "2024-05-17T16:22:53.902Z",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude": 44.94441, "longitude": -93.09327,
"locationName": "Saint Paul, Minnesota, US" },
"totalMemory": "32768 MB",
"agentType": "endpoint",
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" },
"licenseType": "advantage",
"tcpDriverAvailable": true, "_links": { "self": {
"href":
"https://api.thousandeyes.com/v7/endpoint/agents/07ff166d-8309-4775-bbc5-e176dd94ec14" } } } |
|
Comments: |
|
List Agents
|
v6 |
v7 |
|
GET
/v6/endpoint-agents |
GET
/v7/endpoint/agents |
|
Request
Body |
|
|
|
|
|
Response
Body |
|
|
"pages":
{ "current": 1 },
"endpointAgents": [ {
"agentId":
"bfb0afbd-44b7-43d7-a028-5567471faab7",
"agentName": "test-name-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.5 (Build 23F79)",
"kernelVersion": "Darwin 23.5.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-21 17:24:52", "status":
"enabled", "deleted": false, "version":
"1.195.0",
"createdTime":
"2024-05-17 18:48:12",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" }, "clients": [ {
"userProfile": { "userName":
"api-user" },
"browserExtensions": [] } ],
"totalMemory": "32768 MB",
"agentType": "enterprise", "networkInterfaceProfiles": [ {
"interfaceName": "en0",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.101",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ], "hardwareType":
"ETHERNET",
"ethernetProfile": {
"linkSpeed": 1000 } }, {
"interfaceName": "en1",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.208",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ], "hardwareType":
"WIRELESS",
"wirelessProfile": { "bssid":
"1c:8b:76:89:87:5d", "ssid":
"HomeWiFi", "rssi":
-65,
"channel": 136, "phyMode":
"802.11ac" } } ],
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" } } ] } |
{ "agents": [ { "id":
"bfb0afbd-44b7-43d7-a028-5567471faab7", "aid":
"1234", "name":
"test-machine-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.5 (Build 23F79)", "platform":
"mac",
"kernelVersion": "Darwin 23.5.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-21T17:24:52.605Z", "status":
"enabled", "deleted": false, "version":
"1.195.0",
"createdAt":
"2024-05-17T18:48:12.770Z",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" },
"totalMemory": "32768 MB",
"agentType": "endpoint",
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" }, "licenseType":
"advantage", "tcpDriverAvailable": true, "_links":
{
"self": { "href":
"https://api.thousandeyes.com/v7/endpoint/agents/bfb0afbd-44b7-43d7-a028-5567471faab7" } } } ],
"totalAgents": 1, "_links": { "self": {
"href":
"https://api.thousandeyes.com/v7/endpoint/agents?aid=134813" } } } |
|
Comments: |
|
Transfer Agent
|
v6 |
v7 |
|
POST
/v6/endpoint-agents/transfer |
POST /v7/endpoint/agents/{agentId}/transfer |
|
Request
Body |
|
|
machine_id,from_aid,to_aid 07ff166d-8309-4775-bbc5-e176dd94ec14,111,222 07ff166d-8309-4775-bbc5-e176dd94ec15,333,222 |
{ “toAid”: “222”
} |
|
Response
Body |
|
|
{
"endpointAgentsTransfer": {
"machineCount": 2 } } |
Transfer
initiated |
|
Comments: v6 request body should contain a comma delimited
list of agents in CSV format v6
request Content-Type should be
‘text/csv’ or ‘text/plain’ |
|
Update Agent
|
v6 |
v7 |
|
POST /v6/endpoint-agents/{agentId} |
PATCH /v7/endpoint/agents/{agentId} |
|
Request
Body |
|
|
{ “newAgentName”: “new name” } |
{ “licenseType”: “essentials”, “name”:
“new name” } |
|
Response
Body |
|
|
{
"endpointAgents": [ {
"agentId": "07ff166d-8309-4775-bbc5-e176dd94ec14",
"agentName": "new name",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)",
"kernelVersion": "Darwin 23.4.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17 17:37:57", "status":
"enabled", "deleted": false, "version":
"1.195.0",
"createdTime": "2024-05-17 16:22:53",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" }, "clients": [ {
"userProfile": { "userName":
"test-user" },
"browserExtensions": [] } ],
"totalMemory": "32768 MB",
"agentType": "enterprise",
"networkInterfaceProfiles": [ {
"interfaceName": "en0",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.101",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "ETHERNET",
"ethernetProfile": {
"linkSpeed": 1000 } }, {
"interfaceName": "en1",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.208",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "WIRELESS",
"wirelessProfile": { "bssid":
"1c:8b:76:89:87:5d", "ssid":
"HomeNetwork", "rssi":
-65, "channel":
136, "phyMode":
"802.11ac" } } ],
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" } } ] } |
{ "id":
"07ff166d-8309-4775-bbc5-e176dd94ec14", "aid": "134813", "name": "new name",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)", "platform": "mac",
"kernelVersion": "Darwin 23.4.0", "manufacturer": "Apple,
Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17T17:37:57.940Z", "status": "enabled", "deleted": false, "version": "1.195.0",
"createdAt": "2024-05-17T16:22:53.902Z",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude": 44.94441, "longitude": -93.09327,
"locationName": "Saint Paul, Minnesota, US" },
"totalMemory": "32768 MB",
"agentType": "endpoint",
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" }, "licenseType": "essentials",
"tcpDriverAvailable": true, "_links": { "self": {
"href":
"https://api.thousandeyes.com/v7/endpoint/agents/07ff166d-8309-4775-bbc5-e176dd94ec14" } } } |
|
Comments: |
|
Disable Agent
|
v6 |
v7 |
|
POST /v6/endpoint-agents/{agentId}/disable |
POST /v7/endpoint/agents/{agentId}/disable |
|
Request
Body |
|
|
|
|
|
Response
Body |
|
|
{
"endpointAgents": [ {
"agentId": "07ff166d-8309-4775-bbc5-e176dd94ec14",
"agentName": "test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)",
"kernelVersion": "Darwin 23.4.0", "manufacturer":
"Apple, Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17 16:32:54", "status": "disabled", "deleted": false, "version":
"1.195.0",
"createdTime": "2024-05-17 16:22:53",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude":
44.94441, "longitude":
-93.09327,
"locationName": "Saint Paul, Minnesota, US" }, "clients": [ {
"userProfile": { "userName":
"test-user" },
"browserExtensions": [] } ],
"totalMemory": "32768 MB",
"agentType": "enterprise",
"networkInterfaceProfiles": [ {
"interfaceName": "en0",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.101",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "ETHERNET",
"ethernetProfile": {
"linkSpeed": 1000 } }, {
"interfaceName": "en1",
"addressProfiles": [ {
"addressType": "UNIQUE_LOCAL",
"ipAddress": "192.168.1.208",
"prefixLength": 24,
"gateway": "192.168.1.1",
"routerHardwareAddress": "1c:8b:76:89:87:58" } ],
"hardwareType": "WIRELESS",
"wirelessProfile": { "bssid":
"1c:8b:76:89:87:5d", "ssid":
"HomeNetwork", "rssi":
-63, "channel":
136, "phyMode":
"802.11ac" } } ],
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" } } ] } |
{ "id":
"07ff166d-8309-4775-bbc5-e176dd94ec14", "aid": "134813", "name":
"test-agent-1",
"computerName": "test-machine-name",
"osVersion": "Version 14.4.1 (Build 23E224)", "platform": "mac",
"kernelVersion": "Darwin 23.4.0", "manufacturer": "Apple,
Inc.", "model":
"Macmini8,1",
"lastSeen": "2024-05-17T16:42:55.352Z", "status": "disabled", "deleted": false, "version": "1.195.0",
"createdAt": "2024-05-17T16:22:53.902Z",
"numberOfClients": 1,
"publicIP": "140.106.39.233", "location": { "latitude": 44.94441, "longitude": -93.09327,
"locationName": "Saint Paul, Minnesota, US" },
"totalMemory": "32768 MB",
"agentType": "endpoint",
"asnDetails": {
"asNumber": 400268,
"asName": "SWIFTCURRENT-CONNECT" },
"licenseType": "advantage",
"tcpDriverAvailable": true, "_links": { "self": {
"href":
"https://api.thousandeyes.com/v7/endpoint/agents/07ff166d-8309-4775-bbc5-e176dd94ec14" } } } |
|
Comments: |
|
Delete Agent
|
v6 |
v7 |
|
DELETE /v6/endpoint-agents/{agentId} |
DELETE /v7/endpoint/agents/{agentId} |
|
Request
Body |
|
|
|
|
|
Response
Body |
|
|
A
successful request returns an empty response body |
A
successful request returns an empty response body |
|
Comments: |
|