Endpoint: /sites/{siteId}

Returns all site settings for the specified Site ID; To obtain the Site ID a GET request will need to be done against the /sites endpoint prior to making this request.

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteid}

GET Body Sample

Copy

### Returns all site settings for the specified Site ID ###
GET https://{{host}}/admin/v2/sites/{{Siteid}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy

{ 
  "data": { 
"type": "site",
"id": "892b16dc-24a8-473f-a74e-c597b824c879",
"attributes": { "name": "MySite",
"general": { "authType": "EFT",
 "rootFolder": "C:\\InetPub\\EFTRoot\\MySite\\",
 "lastModifiedBy": "WIN-IKTLG8MULV9\\Administrator",
 "lastModifiedTime": 1643636803
},
"listenerSettings": { 
 "accountManagementUrl": "https://172.22.150.62/manageaccount",
 "httpDomain": "172.22.150.62",
 "listenIps": [ "0.0.0.0" ], 
 "ftps": { "explicitPort": 21,
 "implicitPort": 990 },
 "https": { "port": 443 },
 "sftp": { "port": 22 } },
 "workspacesSettings": { "enabled": true },
 "dmz": { "enabled": false,
 "server": [ { "nodeName": "WIN-IKTLG8MULV9",
 "ipAddresses": [ "" ],
 "port": 44500 } ] } } },
 "links": { "metrics": 
 "admin/v2/sites/892b16dc-24a8-473f-a74e-c597b824c879/metrics", 
"self": "admin/v2/sites/892b16dc-24a8-473f-a74e-c597b824c879" } 
}

GET PowerShell Sample

Copy

####Added 2/01/2020
### Returns all site settings for the specified Site ID ###
### User must obtain the SiteID from Get Sites
Write-Output "Site"
Write-Output "----"
#$siteID = Enter SiteID here
$siteList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID" 
-Method 'GET' -Headers $authHeader
Write-Output $siteList | ConvertTo-Json