Endpoint:/sites/{siteID}/dmz

NOTE: Available as of EFT 8.1.0

Returns DMZ gateway settings from specified site (GET) and updates DMZ gateway settings (PATCH).

GET
PATCH

Method & URL

GET https://{{host}}/admin/v2/sites/{{Siteid}}/dmz

GET Body Sample

Copy

### GET SITE DMZ INFO ###
GET https://{{host}}/admin/v2/sites/{{Siteid}}/dmz HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy

{"data":{"type":"DMZGateway","attributes":{"enabled":false,"hosts":[],"port":44500,
"securePNC":{"enabled":false,"publicKeyPath":""},"ftp":{"enabled":false,"port":21},
"ftpsExpl":{"enabled":false,"port":21},"ftpsImpl":{"enabled":false,"port":990},
"sftp":{"enabled":false,"port":22},"http":{"enabled":false,"port":80},"https":{
"enabled":false,"port":443},"internalDomain":{"HTTPDomain":"","emailDomainPatterns":"",
"allowADorLDAPAuth":true,"isExclusiveADorLDAP":false,"isRequired2FAforInternalUsers":false,
"SSLCertificate":{"certPath":"","keyPath":"","passphrase":"UpKUJq1sD4Yfb1Hz8ZFiRw=="}},
"pasv":{"enabled":false,"listenIP":"0.0.0.0","portMin":28000,"portMax":30000},
"remoteAdmin":{"enabled":false,"port":1100},"acceleration":{"enabled":false,"port":8443}},
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/dmz"}}}

GET PowerShell Sample

Copy

$siteID = $siteList.data[0].id

# get DMZ info
Write-Output "DMZ INFO"
Write-Output "-----"
$dmzList = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/dmz" -Method 'GET' -Headers $authHeader
Write-Output $dmzList | ConvertTo-Json

PATCH Body Sample

Copy

### PATCH (UPDATE) DMZ INFO ###
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/dmz HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "type": "DMZGateway",
    "attributes": {
      "hosts":
      [ 
        "10.91.160.102"
      ],
      "port":"44500",
      "enabled": true,
      "ftpEnabled": false,
      "ftpsEnabled": true,
      "ftpsExpEnabled": true,
      "sftpEnabled": false,
      "ftpPort": 21,
      "ftpsPort": 990,
      "httpsEnabled": true,
      "adminEnabled": true,
      "adminPort": 1100
    }
  }
}
###

PATCH Response Body Sample

Copy

{"data":{"type":"DMZGateway","attributes":{"enabled":true,"hosts":["10.91.160.102"],
"port":44500,"securePNC":{"enabled":false,"publicKeyPath":""},"ftp":{"enabled":false,"port":21},
"ftpsExpl":{"enabled":false,"port":21},"ftpsImpl":{"enabled":false,"port":990},
"sftp":{"enabled":false,"port":22},"http":{"enabled":false,"port":80},"https":{
"enabled":false,"port":443},"internalDomain":{"HTTPDomain":"","emailDomainPatterns":"",
"allowADorLDAPAuth":true,"isExclusiveADorLDAP":false,"isRequired2FAforInternalUsers":false,
"SSLCertificate":{"certPath":"","keyPath":"","passphrase":"UpKUJq1sD4Yfb1Hz8ZFiRw=="}},
"pasv":{"enabled":false,"listenIP":"0.0.0.0","portMin":28000,"portMax":30000},
"remoteAdmin":{"enabled":false,"port":1100},"acceleration":{"enabled":false,"port":8443}},
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/dmz"}}}

PATCH PowerShell Sample

Copy

##Patch SITE DMZ settings
Write-Output "Site DMZ PATCH"
Write-Output "-----"
$update = 
'{
  "data": {
    "type": "DMZGateway",
    "attributes": {
      "hosts":
      [ 
        "10.91.160.102"
      ],
      "port":"44500",
      "enabled": true,
      "ftpEnabled": false,
      "ftpsEnabled": true,
      "ftpsExpEnabled": true,
      "sftpEnabled": false,
      "ftpPort": 21,
      "ftpsPort": 990,
      "httpsEnabled": true,
      "adminEnabled": true,
      "adminPort": 1100
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchDMZReturn = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/dmz" -Method 'PATCH' 
-Headers $authHeader -Body $update
Write-Output $patchDMZReturn | ConvertTo-Json