POST SSH/TestDeviceConnection
Verifies that Trust Protection Platform can connect to devices via an SSH connection.
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
Name |
Description |
|
---|---|---|
DeviceGuids | An array of device GUIDs that are present in the certificate inventory. The devices must have an agentless connection to Trust Protection Platform. To get a device GUID, call POST SSH/Devices. |
Returns
TestDeviceConnection returns a HTTP 200 and an array of values for each device:
Name |
Description |
---|---|
DeviceGuid |
The Trust Protection Platform GUID that uniquely identifies a device. |
Error |
null: Trust Protection Platform successfully connected to a device. Otherwise, on failure, this method returns the reason for connection failures. Reasons for failure include:
|
Success |
The result:
|
Example: Use a SSH connection to verify connectivity to devices
Request
POST https://tpp.venafi.example/vedsdk/SSH/TestDeviceConnection Authorization:Bearer 4MyGeneratedBearerTknz== { "deviceGuids":[ "{4ec00781-47bd-4ceb-a313-300d84cb8df6}", "{ac2cc301-717b-43ed-a52b-73e62067c5f6}", "{00000000-0000-0000-0000-000000000000}" ] }
Response
HTTP/1.1 200 OK [ { "DeviceGuid":"{4ec00781-47bd-4ceb-a313-300d84cb8df6}", "Error":null, "Success":true }, { "DeviceGuid":"{00000000-0000-0000-0000-000000000000}", "Error":"Device not found", "Success":false }, { "DeviceGuid":"{ac2cc301-717b-43ed-a52b-73e62067c5f6}", "Error":"An agentless server connection is required", "Success":false } ]