Passwordstate Documentation

Search Remote Site Locations ​

GET /userapi/remotesitelocations

Searching for Remote Site Location records can be achieved via multiple criteria, as outlined by the fields below. The account executing this call must have the 'Remote Site Locations' Security Administrator's role in Passwordstate.

  • SiteID
  • SiteLocation
Powershell
# Search by SiteID
$PasswordstateUrl = 'https://passwordstate/userapi/remotesitelocations/?SiteID=<value>'
                           
# Search by SiteLocation
$PasswordstateUrl = 'https://passwordstate/userapi/remotesitelocations/?SiteLocation=<value>'

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "UserID" = "<UserID>" ; "APIKey" = "<APIKey>" }
Json
# Response
HTTP/1.1 200          
[
    {
        "SiteID":"1",
        "SiteLocation":"Contoso",
        "InTransitKey":"5615feaa9341c0aa2f6245cf0da467472cd36c80c03af0dbe8ab0994196bb3b9",
        "PollFrequency":"5",
        "MaintenanceStart":"13",
        "MaintenanceFinish","14",
        "GatewayURL":"",
        "PurgeSessionRecordings":"0",
        "DiscoveryThreads":"1",
     "Agent Installer Non FIPS Encryption":"passwordstateagent.exe /s SiteID=1 InTransitKey=5615feaa9341c0aa2f6245cf0da467472cd36c80c03af0dbe8ab0994196bb3b9 URL=https://passwordstate.mydomain.com FIPSMode=False",
        "Agent Installer FIPS Encryption":"passwordstateagent.exe /s SiteID=1 InTransitKey=5615feaa9341c0aa2f6245cf0da467472cd36c80c03af0dbe8ab0994196bb3b9 URL=https://passwordstate.mydomain.com FIPSMode=True",
        "UseSSLPowerShell":"False"
    }
]