Endpoint: /sites/{siteId}/ram/agents

NOTE: Available as of EFT 8.1.0

Returns a list of remote agents from a specified site.

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/ram/agents

GET Body Sample

Copy

### GET Remote Agents
# @name RAMList
GET  https://{{host}}/admin/v2/sites/{{Siteid}}/ram/agents 
HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
##
###
@remoteAgentID = {{RAMList.response.body.$.data[0].id}}

##
#Get Specific RAM Agent ID
GET https://{{host}}/admin/v2/sites/{{Siteid}}/ram/agents/{{remoteAgentID}} 
HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy

{ "data": { "id": "4dfd3f28-6ba9-4e19-ae7b-4d3b0b4314f6", "type": "remote-agent", "attributes": 
{ "name": "ag_IV-2019A", "clid": "00000000-0000-0000-0000-000000000000", "state": "PendingJoin", 
"pausing": false, "resuming": false, "netBios": "IV-2019A", "domain": "", "winOEM": "x64 (AMD or Intel)", 
"ips": [ "fe80::904:aa5a:7256:ca57 (Ethernet)", "10.91.160.123 (Ethernet)", "ff01::1 (Ethernet)", 
"ff02::1 (Ethernet)", "ff02::c (Ethernet)", "ff02::fb (Ethernet)", "ff02::1:3 (Ethernet)", 
"ff02::1:ff56:ca57 (Ethernet)", "224.0.0.1 (Ethernet)", "224.0.0.251 (Ethernet)", 
"224.0.0.252 (Ethernet)", "239.255.255.250 (Ethernet)", "::1 (Loopback Pseudo-Interface 1)", 
"127.0.0.1 (Loopback Pseudo-Interface 1)", "ff02::c (Loopback Pseudo-Interface 1)", 
"239.255.255.250 (Loopback Pseudo-Interface 1)" ], "macAddresses": [ "0-15-5d-64-e-2c" ], 
"lastUpdate": 0, "version": "8.1.0.6", "lastKnownIP": "10.91.160.123", "nextUpdate": 0, 
"approvedTime": 0, "secret": "7102da9c0219696b82679072b9c2f6e6d46fc0da9aa58d3fc1aa2e94f7858cde", 
"peakVersion": "8.1.0.6" }, "links": { "self": 
"/admin/v2/sites/4ebb829f-f84c-4355-8d55-d43a2852ca12/ram/agents/4dfd3f28-6ba9-4e19-ae7b-4d3b0b4314f6" } } }

GET PowerShell Sample

Copy

###GET Remote Agents
Write-Output "Remote Agents"
Write-Output "----"
$ramAgentList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/ram/agents" 
-Method 'GET' -Headers $authHeader
$ramAgentID = $ramAgentList.data[0].id

###GET Remote Agent Settings
Write-Output "GET Specific Remote Agent Settings: " $ramAgentID
Write-Output "----"
$ramAgent = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/ram/agents/$ramAgentID" 
-Method 'GET' -Headers $authHeader
Write-Output $ramAgent | ConvertTo-Json