Create Encryption Key
post
/services/{version}/enckeys/{keyName}
Required Role: Administrator
Create an Encryption Key.
Request
Supported Media Types
- application/json
Path Parameters
-
keyName(required): string
Minimum Length:
1Maximum Length:24Pattern:^[A-Za-z_$][A-Za-z0-9_$]*$The name of the Encryption Key.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Encryption Key
Title:
Oracle GoldenGate Encryption KeyThis schema describes an encryption key, used to encrypt data
Match One
Show Source
-
object Oracle GoldenGate Encryption Key-x-oneOf[0]
128-bit encryption key
-
object Oracle GoldenGate Encryption Key-x-oneOf[1]
192-bit encryption key
-
object Oracle GoldenGate Encryption Key-x-oneOf[2]
256-bit encryption key
Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[0]
Type:
object128-bit encryption key
Show Source
-
$schema:
Allowed Values:
[ "ogg:encryptKey" ] -
bitLength(required):
Allowed Values:
[ "128" ]Length of the encryption key, in bits -
keyValue:
string
Minimum Length:
34Maximum Length:34Pattern:0x[A-Fa-f0-9]{32}An optional encryption key value. If not provided, one will be generated.
Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[1]
Type:
object192-bit encryption key
Show Source
-
$schema:
Allowed Values:
[ "ogg:encryptKey" ] -
bitLength(required):
Allowed Values:
[ "192" ]Length of the encryption key, in bits -
keyValue:
string
Minimum Length:
50Maximum Length:50Pattern:0x[A-Fa-f0-9]{48}An optional encryption key value. If not provided, one will be generated.
Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[2]
Type:
object256-bit encryption key
Show Source
-
$schema:
Allowed Values:
[ "ogg:encryptKey" ] -
bitLength(required):
Allowed Values:
[ "256" ]Length of the encryption key, in bits -
keyValue:
string
Minimum Length:
66Maximum Length:66Pattern:0x[A-Fa-f0-9]{64}An optional encryption key value. If not provided, one will be generated.
Example Request (application/json)
{
"bitLength":"128"
}Response
Supported Media Types
- application/json
201 Response
Encryption Key created successfully.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/enckeys/superkey",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/enckeys/superkey",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
]
}