Endpoint: /server

Returns and update server settings.

Method & URL

GET https://[server URL]:[port]/admin/v2/server

GET Body Sample

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

GET Response Body Sample

Copy 
{
"data": { 
"type": "server", 
"id": "1", 
"attributes": { 
  "version": "8.0.6.16", 
  "general": { 
     "configFilePath": "C:\\ProgramData\\Globalscape\\EFT Server Enterprise\\", 
     "enableUtcInListings": true, 
      "lastModifiedBy": "admin", 
      "lastModifiedTime": 1633717057 
     }, 
     "listenerSettings": { 
        "adminPort": 1100, 
        "enableRemoteAdministration": true, 
         "listenIps": [ "0.0.0.0" ],
…
}

GET PowerShell Sample

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

Method & URL

PATCH https://[server URL]:[port]/admin/v2/server

PATCH Body Sample

Copy 
PATCH  https://{{host}}/admin/v2/server HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
{   
"data": {
    "type": "server",
    "id": "1",
    "attributes":{
        "version":"",
    "smtp": {
        "login": "",
        "password": "",
        "port": 587,
        "senderAddr": "EFT@mailserver.net",
        "senderName": "Globalscape EFT",
        "server": "smtp.mailserver.net",
        "useAuthentication": false,
        "useImplicitTLS": false
      }
    }
  }
}

PATCH Response Body Sample

The response will return the same response as the GET request, however, it will now include the updated PATCH request(s).

PATCH PowerShell Sample

Copy 
##Patch Server - patching the SMTP settings
Write-Output "Server Patch"
Write-Output "-----"
$update = 
'{
    "data":{
        "type": "server",
        "id": "1",
        "attributes": {
            "version": "",
        "smtp": {
            "login": "",
            "password": "",
            "port": 587,
            "senderAddr": "EFT@mailserver.net",
            "senderName": "Globalscape EFT",
            "server": "smtp.mailserver.net",
            "useAuthentication": false,
            "useImplicitTLS": false
         }  
         }
     }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/server" -Method 'PATCH' -Headers $authHeader -Body $update