Hosts ​
Multiple methods are available with the API to query for Hosts which are already added to Passwordstate, or to add new Host records, or delete existing Host records.
Host records in Passwordstate are primarily used for facilitating Password resets on various Host types, and also for the Remote Session Launcher utility.
To manage Host records via the API, you must be using the 'Hosts' API Key from the screen Administration -> System Settings -> API tab. APIKey can be specified either in the Header Request, or in the HTTP body.
| Heading | Data Type | Description |
|---|---|---|
| HostName | String (200) | The name of the Host - FQDN host names are preferred if possible |
| HostType | String (50) | A Host Type which describes the Host i.e. Windows, Linux, Switch, Router, etc. A list of Host Types can be found on the screen Administration -> Passwordstate Administration -> Host Types and Operating Systems |
| OperatingSystem | String (50) | The type of Operating System the Host is using. A list of Operating Systems can be found on the screen Administration -> Passwordstate Administration -> Host Types and Operating Systems |
| DatabaseServerType | String (200) | Specifies the type of Database Server if applicable - MariaDB, MySQL, Oracle, PostgreSQL or SQL Server. |
| SQLInstanceName | String (100) | Indicates either the Microsoft SQL Server Instance Name, Oracle Service Name or PostgreSQL Database Name. |
| DatabasePortNumber | Integer | Indicates the Port Number the database server is accessible on. Leaving the Port Number blank is most cases should work, but you can specify non-standard port numbers if required |
| RemoteConnectionType | String (50) | The type of Remote Connection Protocol for the server i.e. RDP, SSH, Telnet or VNC. |
| RemoteConnectionPortNumber | Integer | The Port Number used for the Remote Connection type. Default Port Numbers are RDP: 3389, SSH: 22, Teamviewer: 0, Telnet: 23 and VNC: 5901. |
| RemoteConnectionParameters | String (500) | If the required Remote Session Client requires additional parameters to be specified to connect to the remote Host, they can be specified using this field. |
| Tag | String (1000) | A descriptive Tag for the Host record. |
| Title | String (200) | If the Title field has a value, this will be displayed in the Hosts Navigation Tree instead. |
| SiteID | Integer | The SiteID the Host record belongs to (SiteID of 0 for site of type Internal). |
| InternalIP | String (50) | The Internal IP Address of the Host. |
| ExternalIP | String (50) | The Externally facing IP Address of the Host i.e. if an Azure, Amazon, or an internally hosted server which has been exposed external to your standard network. |
| MACAddress | String (50) | The network MAC Address for the Host. |
| SessionRecording | Boolean | Indicates whether all sessions will be recorded for this host record. |
| VirtualMachine | Boolean | If this is a Virtual Machine or not. |
| VirtualMachineType | String (20) | If a Virtual Machine, if it is of type Amazon, Azure, Google, HyperV, Virtualbox, VMware or Xen. |
| Notes | String (NA) | Any additional Notes for the Host. |
| APIKey | String | The Hosts API Key authorized to manage Host records, from the screen Administration -> System Settings -> API tab |