GuidesAPI ReferenceGitHub
API Reference
Community ForumsTwitter

Retrieve an SSH key.

post
https://example.com/ServerManage/RetrieveSshKey

The GetAsFile property determines if the return is a JSON strong or a file. Allows retrieval of only private key OR public key - not both. Does not return other SSH key related fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID of the SSH Key to retrieve

string
Defaults to PEM

KeyFormat to retrieve the key in - only works for PublicKey

string
required

Which key to retrieve from the pair, must be either PublicKey, PrivateKey, or PPK

string

Passphrase to use for encrypting the PrivateKey

boolean
Defaults to false

Should the key be retrieved as file?

Response

Updated 8 months ago

Language
LoadingLoading…
Response
Choose an example:
*/*

Updated 8 months ago