POST SSH/Devices

Finds devices in the Policy tree that match the filtering criteria. The method includes paging support. For example, SSH/Devices can find all non-compliant devices in your SSH inventory.

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

PageSize

Size of page returned.

Offset (Optional)

Offset for query results.

This count of a record will be skipped.

SshDeviceFilter (Optional)

(Optional) SshDeviceFilter object specifying all searching criteria. For more information, see SSH SshDeviceFilter object.

Returns

Response description

Name

Description

Data

The array of SSH SshDeviceData object.

Example: Report on Device Keysets

Request

POST https://tpp.venafi.example/vedsdk/SSH/Devices 
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "PageSize" : 20,
   "Offset" : 0,
   "SshDeviceFilter":{"DeviceName":["myserver"]}
}

Response

HTTP/1.1 200 OK
{  
   "Data":[  
      {  
         "DN":"\\VED\\Policy\\myserver.mydomain",
         "DeviceGuid":"{0bede523-6f78-4262-b30a-ad71e233c5c6}",
         "HostName":"myserver.mydomain",
         "IsCompliant":true,
         "Type":"Server"
      }
   ]
}