GET SSH Servers ID

The GET /SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption./Servers/{id} method is used to retrieve an SSH server with the specified ID from Keyfactor Command. This method returns HTTP 200 OK on a success with details for the specified SSH server.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/ssh/server_admin/
OR
/ssh/enterprise_admin/

SSH actions are affected by ownership on the server group to which the server belongs and limited for users with only the Server Admin (/ssh/server_admin/) role. For more information, see SSH Permissions.

Table 764: GET SSH Servers {id} Input Parameters

Name In Description
id Path Required. An integer indicating the Keyfactor Command reference ID for the SSH server to be retrieved.

Use the GET /SSH/Servers method (see GET SSH Servers) to retrieve a list of all the SSH servers to determine the server's ID.

Table 765: GET SSH Servers {id} Response Data

Name Description
ID An integer indicating the Keyfactor Command reference ID for the SSH server. This ID is automatically set by Keyfactor Command.
AgentId A string indicating the Keyfactor Command reference GUID for the SSH orchestrator controlling the SSH server.
Hostname

A string indicating the hostname of the SSH server.
ServerGroupId A string indicating the Keyfactor Command reference GUID for the SSH server group to which the server belongs.
SyncSchedule

An object providing the inventory schedule for the SSH server group to which the SSH server belongs. Inventory schedules cannot be set on an individual SSH server basis. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.

For example:

Copy 
"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}
UnderManagement A Boolean indicating whether the SSH server is in inventory only mode (False) or inventory and publish policy mode (True).
Tip:  If the server group associated with the SSH server is in inventory and publish policy mode, you will not be able to configure the server in inventory only mode.
Owner

An object that indicates the Active Directory user who owns the server group to which the server belongs. The owner can only be set by a Keyfactor Command user with the SSH Enterprise Admin role. See SSH Server Group Operations in the Keyfactor Command Reference Guide for more information. ClosedShow owner details.
GroupName A string indicating the SSH server group to which the SSH server belongs. See SSH Server Group Operations in the Keyfactor Command Reference Guide for more information.
Orchestrator

A string indicating the name the SSH orchestrator provided to Keyfactor Command when it registered. This value is configurable when the orchestrator is installed.

For more information about the orchestrator, see Bash Orchestrator in the Keyfactor Orchestrators Installation and Configuration Guide.
Port An integer indicating the port that is configured for SSH on the SSH server. The default is 22.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.