View the SSH Key Description



Returns the credential description for the given credential name.

Note: vmspublickey is the only supported credential name.


Path Parameters
Header Parameters
Back to Top


Supported Media Types

200 Response


The response body contains information about the SSH key, including its description.

See Status Codes for information about other possible HTTP status codes.

Body ()
Root Schema : sshkeydesc-response
Type: object
Show Source
Back to Top


The following example shows how to view information about the SSH public key for the given credential name by submitting a GET request on the REST resource using cURL.

  • Currently, the only supported credential name is vmspublickey.

  • The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/credentials/crednames/vmspublickey

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 19 Apr 2016 21:38:40 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the response returned in JSON format.

   "description":"Service user ssh public key which can be used to access the service VM instances",
Back to Top