GET SSH/KeysetDetails

Finds information about every device that shares the same keyset.

Requirements

Permissions: The caller must have Read permission and View permission either on a device with a keyset or on the policy containing the keyset (when keyset is present in the Policy tree).
Token scope: SSH

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Specify parameters in the request URL.

Input parameters
Name	Description
KeysetId	The identifier of a set of public and private key pairs. Depending on your environment, the value may be expressed with or without curly braces {}. You can get the KeysetId, from POST SSH/KeyUsage or the SSH Keyset Inventory. For example:
LoadKeyData (Optional)	The amount of keyset data to return: true: Show general, public, and private key information about a device. false: Default. Show general key information about the device. Omit private key and public key information. General information includes Access, Algorithm, KeysetId, LastRotationDate, Length, ProcessStatus, Type, and ViolationStatus values. For example, if you just want the last key rotation date, specify false.

Returns

GET SSH/KeysetDetails returns:

HTTP 500: Internal Server error and Error: Internal error occurred for invalid requests that contain syntax errors or hidden characters.
HTTP 400: Bad Request for invalid requests.
HTTP 200: If the caller has insufficient privileges, an empty JSON body.
HTTP 200: message and the following information:

Response description
Name	Description
	One SSH Keyset Data object.

Example: Show devices that use the same keyset ID

Request

GET https://tpp.venafi.examplehttps://192.168.6.227/vedsdk/SSH/KeysetDetails?
KeysetId=A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70&LoadKeyData=True
X-Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK

{
   "Access":"192.168.6.243",
   "Algorithm":"DSA",
   "FingerprintMD5":"98:59:2a:7f:e3:f1:bc:ca:aa:5d:65:30:b3:6b:7f:99",
   "FingerprintSHA256":"NsMtm5l8PyDezuQ2dhFMeArDbQFxT/0HdGdxb7Nknss",
   "KeysetId":"A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70",
   "LastRotationDate":null,
   "LastUsed":null,
   "Length":1024,
   "PrivateKeys":[
      {
         "ActiveFrom":"/Date(1528905980897+0300)/",
         "Algorithm":"DSA",
         "AllowedSourceRestriction":null,
         "Approver":[

         ],
         "Comment":null,
         "DeniedSourceRestriction":null,
         "DeviceGuid":"{d8cb6654-8a22-49cf-844d-3478078503e9}",
         "FilePath":"/etc/ssh/ssh_host__dsa_1111",
         "ForceCommand":null,
         "Format":"OpenSSH",
         "IsEncrypted":false,
         "KeyId":4825,
         "KeysetId":"A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70",
         "LastUsed":null,
         "Length":1024,
         "Notes":null,
         "Options":null,
         "ProcessError":null,
         "ProcessStatus":0,
         "Reason":null,
         "Type":"HostPrivateKey",
         "Username":"root",
         "ViolationStatus":[
            33
         ]
      },
      {
         "ActiveFrom":"/Date(1528905980897+0300)/",
         "Algorithm":"DSA",
         "AllowedSourceRestriction":null,
         "Approver":[

         ],
         "Comment":null,
         "DeniedSourceRestriction":null,
         "DeviceGuid":"{46bfb660-6b3d-4566-91aa-c82fb6465cad}",
         "FilePath":"/etc/ssh/ssh_host__dsa_1111",
         "ForceCommand":null,
         "Format":"OpenSSH",
         "IsEncrypted":false,
         "KeyId":6013,
         "KeysetId":"A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70",
         "LastUsed":null,
         "Length":1024,
         "Notes":null,
         "Options":null,
         "ProcessError":null,
         "ProcessStatus":0,
         "Reason":null,
         "Type":"HostPrivateKey",
         "Username":"root",
         "ViolationStatus":[
            33
         ]
      }
   ],
   "ProcessStatus":0,
   "PublicKeys":[
      {
         "ActiveFrom":"/Date(1528905987687+0300)/",
         "Algorithm":"DSA",
         "AllowedSourceRestriction":null,
         "Approver":[

         ],
         "Comment":null,
         "DeniedSourceRestriction":null,
         "DeviceGuid":"{d8cb6654-8a22-49cf-844d-3478078503e9}",
         "FilePath":"/etc/ssh/ssh_host__dsa_1111.pub",
         "ForceCommand":null,
         "Format":"OpenSSH",
         "IsEncrypted":false,
         "KeyId":4826,
         "KeysetId":"A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70",
         "LastUsed":null,
         "Length":1024,
         "Notes":null,
         "Options":null,
         "ProcessError":null,
         "ProcessStatus":0,
         "Reason":null,
         "Type":"UserPublicKey",
         "Username":"root",
         "ViolationStatus":null
      },
      {
         "ActiveFrom":"/Date(1528905987687+0300)/",
         "Algorithm":"DSA",
         "AllowedSourceRestriction":null,
         "Approver":[

         ],
         "Comment":null,
         "DeniedSourceRestriction":null,
         "DeviceGuid":"{46bfb660-6b3d-4566-91aa-c82fb6465cad}",
         "FilePath":"/etc/ssh/ssh_host__dsa_1111.pub",
         "ForceCommand":null,
         "Format":"OpenSSH",
         "IsEncrypted":false,
         "KeyId":6014,
         "KeysetId":"A9AC67A8201B413CDBE8F92AB6A72FF6AEC98C70",
         "LastUsed":null,
         "Length":1024,
         "Notes":null,
         "Options":null,
         "ProcessError":null,
         "ProcessStatus":0,
         "Reason":null,
         "Type":"HostPublicKey",
         "Username":"root",
         "ViolationStatus":null
      }
   ],
   "RotationStage":null,
   "Type":"Host",
   "ViolationStatus":[
      33
   ]
}