Endpoint:/server/status

Returns server information

NOTE: This endpoint works in v8.1, but not in v8.2 and later

  • GET

Method & URL

GET https://[server URL]:[port]/admin/v1/server/status

GET Body Sample

Copy 
GET https://{{host}}/admin/v1/server/status HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy 
{"nodes":[{"activity":{"activeClientDownloadBytesPerSecond":0,"activeClientDownloadCount":0,
"activeClientUploadBytesPerSecond":0,"activeClientUploadCount":0,"activeServerDownloadBytesPerSecond":0,
"activeServerDownloadCount":0,"activeServerUploadBytesPerSecond":0,"activeServerUploadCount":0,
"connectedAdminCount":1,"connectedUserCount":0,"runningAwTaskCount":0,"runningEventRuleCount":0},
"isInCluster":false,"isMaster":false,"isStarted":true,"licenses":[{"module":"AAMModule",
"registrationState":"Evaluation period"},{"module":"ARMModule","registrationState":"Evaluation period"},
{"module":"AS2Module","registrationState":"Evaluation period"},{"module":"AWModule",
"registrationState":"Evaluation period"},{"module":"AccelerateModule",
"registrationState":"Requires Activation"},{"module":"CloudConnectorModule",
"registrationState":"Evaluation period"},{"module":"DMZGWModule","registrationState":"Evaluation period"},
{"module":"EFTServer","registrationState":"Evaluation period"},{"module":"EnterpriseActionsWModule",
"registrationState":"Evaluation period"},{"module":"FTPModule","registrationState":"Evaluation period"},
{"module":"FileTransferClientModule","registrationState":"Evaluation period"},{"module":"FolderMonitorEventModule",
"registrationState":"Evaluation period"},{"module":"HSModule","registrationState":"Evaluation period"},
{"module":"HTTPModule","registrationState":"Evaluation period"},{"module":"PGPModule",
"registrationState":"Evaluation period"},{"module":"RAModule","registrationState":"Evaluation period"},
{"module":"SSHModule","registrationState":"Evaluation period"},{"module":"SecureFormsModule",
"registrationState":"Evaluation period"},{"module":"TimerEventModule","registrationState":"Evaluation period"},
{"licensesAvailable":100,"module":"WorkspacesModule","registrationState":"Evaluation period","usedLicenses":0}],
"localTime":1659595722,"name":"DY-Win2019-1a","upTime":52215}]}

GET PowerShell Sample

Copy 
#get Server Metrics
Write-Output "Get Server Metrics"
Write-Output "-----"
$serverMetrics = Invoke-RestMethod -Uri "$baseURL/v1/server/status" 
-Method 'GET' -Headers $authHeader
Write-Output $serverMetrics | ConvertTo-Json
foreach ($server in $serverMetrics.data)
{
    Write-Output ("Server $($serverMetrics.data)") 
}