Retrieve Encryption Key
get
/services/{version}/enckeys/{keyName}
Retrieve details for an Encryption Key.
Request
Path Parameters
-
keyName: string
Minimum Length:
1
Maximum Length:24
Pattern:^[A-Za-z_$][A-Za-z0-9_$]*$
The name of the Encryption Key.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Encryption Key details retrieved.
Root Schema : Oracle GoldenGate Encryption Key
Type:
object
Title:
Oracle GoldenGate Encryption Key
This schema describes an encryption key, used to encrypt data
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:encryptKey" ]
-
bitLength:
Allowed Values:
[ 128, 192, 256 ]
Length of the encryption key, in bits
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/enckeys/superkey",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/enckeys/superkey",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/keyName",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:encryptKey",
"bitLength":128
}
}