Retrieve the SSH Key Value Using Query Parameters
get
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/credentials
Returns one or more SSH key values 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 Integration Classic 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).
Request
Path Parameters
-
identityDomainId: string
Identity domain ID for the Oracle Integration Classic account.
Query Parameters
-
credname(optional): string
Unique credential name.
Note:
vmspublickey
is the only supported credential name. This is the default if a credential name is not supplied. -
serviceName(optional): string
Name of the Oracle Integration Classic instance. If a service name is not supplied, the request will return all service instances for the given identity domain ID.
Header Parameters
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Integration Classic account.
Response
Supported Media Types
- application/json
200 Response
OK.
The response body contains details about one or more SSH keys.
Root Schema : keyvaluequery-response
Type:
object
The response body contains details about one or more SSH keys.
Show Source
-
componentType(optional):
string
Type of service component. Possible values include:
WLS
,DB
. -
computeKeyName(optional):
string
Compute sshkey object key name.
-
credName(optional):
string
Credential name. Currently, the only supported credential name is
vmspublickey
. -
credType(optional):
string
Credential type. Only supported value is
SSH
. -
description(optional):
string
Credential description of the credential name.
-
hasMore(optional):
boolean
Flag that specifies whether the list returned by the query is full (
false
) or partial (true
).When the list is partial, use the
offset
query parameter to fetch additional results. By default,offset
is 0 (zero) andlimitRowCount
is 50. -
identityDomain(optional):
string
Identity domain ID for the Oracle Integration Classic account.
-
items(optional):
string
Groups SSH key value details returned by the query.
-
lastUpdateMessage(optional):
string
Message returned from the last update for the SSH key. For example:
newly created
,updated by username
. -
lastUpdateStatus(optional):
string
Status of the last update for the SSH key.
-
lastUpdateTime(optional):
string
Date and time the SSH key was last updated.
-
osUserName(optional):
string
Virtual machine OS user name. Only supported value is
opc
. -
parentType(optional):
string
Valid value is
SERVICE
. -
publicKey(optional):
string
Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle Integration Classic instance using an SSH client.
-
serviceName(optional):
string
Name of the Oracle Integration Classic instance.
-
serviceState(optional):
string
State of the service instance. For example,
RUNNING
. -
serviceType(optional):
string
Cloud service type. Valid value is
IntegrationCloud
for Oracle Integration Classic. -
totalResults(optional):
integer
Number of results returned by the query.