POST SSH/KeyUsage

Finds all key usage records matching the specified filtering criteria. This method includes paging support.

Requirements

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

Input parameters
Name	Description
SshKeyUsageFilter	A filter to find relevant key usage for specific hosts. For more information, see SSH SshKeyUsageFilter object.
PageSize	(Optional) The maximum number of records to return in one API call.
Offset (Optional)	(Optional) For large query results. The offset for query results. The number of records to skip. To return all records based on SshKeyUsageFilter, specify 0.

Returns

Response description
Name	Description
Data	A record for each key: SSH SshKeyUsageData object.

Example: Show key usage records

Request

POST https://tpp.venafi.example/vedsdk/SSH/KeyUsage
X-Authorization:Bearer 4MyGeneratedBearerTknz== 
{
   "SshKeyUsageFilter":[
      {
         "ServerName":[
            "host71506.test29653.com"
         ],
         "ClientName":[
            "10.240.102.94"
         ],
         "ServerAccount":[
            "user1"
         ]
      }
   ],
   "PageSize":1000,
   "Offset":0,
   "LoadKeyData":true
}

Response

HTTP/1.1 200 OK
{
   "Data":[
      {
         "Alert":1,
         "AuthorizedKeyId":null,
         "ClientName":"10.240.102.94",
         "Fingerprint":"c8:88:e3:c6:ce:cc:70:1c:19:bd:52:9c:ba:cc:14:c8",
         "KeyUsageId":1,
         "KeysetId":null,
         "LastUsed":"2018-06-19T07:28:53.0000000-06:00",
         "PrivateKeyId":null,
         "ServerAccount":"user1",
         "ServerName":"host71506.test29653.com"
      }
   ]
}