Retrieve the SSH Key Description Using Query Parameters



Returns one or more credential descriptions for the given query parameters.
  • Use the ?credname query parameter to retrieve results for a given credential name.
  • Use the ?serviceName query parameter to retrieve results for a given Oracle Java Cloud Service instance.

Note the following:

  • By default, 50 keys are returned by a given query. Use the ?limitRowCount query parameter to control the page size (number of results returned in a single request).
  • Use the ?offset query parameter to fetch additional results, if available. By default, offset is 0 (zero).


Path Parameters
Query Parameters
  • Unique credential name.

    Note: vmspublickey is the only supported credential name. This is the default if a credential name is not supplied.

  • Name of the Oracle Java Cloud Service instance. If a service name is not supplied, the request will return all service instances for the given identity domain ID.
Header Parameters
Back to Top


Supported Media Types

200 Response


The response body contains general information about one or more SSH keys (including their descriptions).

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

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


The following example shows how to retrieve SSH key descriptions by using query parameters in 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/credentials/crednames?credname=vmspublickey&serviceName=ExampleInstance"

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 30 Aug 2016 02:09:24 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the response returned in JSON format for a given credential name and service name.

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