GET SSH Server Groups Name

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./ServerGroups/{name} method is used to retrieve an SSH server group with the specified name from Keyfactor Command. This method returns HTTP 200 OK on a success with details for the specified SSH server group.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SSH: ServerAdmin OR
SSH: EnterpriseAdmin

SSH actions are affected by ownership on the server group and limited for users with only the ServerAdmin role. For more information, see SSH Permissions in the Keyfactor Command Reference Guide.

Table 526: GET SSH Server Groups {name} Input Parameters

Name In Description
name Path Required. A string indicating the full name of the SSH server group to be retrieved.

Table 527: GET SSH Server Groups {name} Response Data

Name In Description
ID Body A string indicating the Keyfactor Command reference GUID for the SSH server group. This GUID is automatically set by Keyfactor Command.
Owner Body

An object indicating the Active Directory user who owns the server group. See SSH Server Groups in the Keyfactor Command Reference Guide for more information. ClosedShow owner details.
GroupName Body A string indicating the name of the SSH server group.
SyncSchedule Body

An array providing the inventory schedule for the SSH server group. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.

For example:

"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}
UnderManagement Body A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True).
ServerCount Body An integer indicating the number of SSH servers that belong to the server group.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.