Remote Site Locations Overview ​
Multiple methods are available with the API to query Remote Site Locations entries, or to add, update and delete entries.
The account executing the calls for Remote Site Locations, must have the 'Remote Site Locations' Security Administrator's role in Passwordstate.
| Heading | Data Type | Description |
|---|---|---|
| SiteID | Integer | The database ID for the Remote Site Location entry |
| SiteLocation | String | The description of the Remote Site Location entry |
| InTransitKey | String | The unique separate encryption key for the Remote Site Location entry |
| PollFrequency | Integer | The time in minutes in which the Remote Agent will poll back to the API to look for new work items i.e. Discovery Jobs, Password Resets, Account Validations |
| MaintenanceStart | String | The start hour for a maintenance period where the agent will not poll back for any new work items. Hour is specified in 24 hour format i.e. 1am would be specified as 01, and 1pm would be specified as 13 (use 2 digit values) |
| MaintenanceFinish | String | The finish hour for a maintenance period where the agent will not poll back for any new work items |
| GatewayURL | String | If using the Remote Session Gateway which can be configured with the Remote Site Locations agent, specify the URL here for connecting to the gateway |
| PurgeSessionRecordings | Integer | If recording remote sessions when using the Remote Session Gateway, this field indicates when old records will be automatically deleted - value is specified in Days |
| DiscoveryThreads | Integer | When performing Account Discovery Jobs, the fields indicates how many concurrent threads will be executed when querying different hosts |
| UseSSLPowerShell | Boolean | Whether or not to use the -UseSSL parameter in PowerShell scripts for the Invoke-Command cmdlet |