Create Backend
post
/services/{version}/installation/configuration/backends
Required Role: Security
Create a new Configuration Service Backend.
Request
Supported Media Types
- application/json
Path Parameters
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Configuration Service Backend
Type:
object
Title:
Configuration Service Backend
Each configuration data item is stored in a "Backend" which is a reference to an external location for data persistence, encryption, and other capabilities. A Backend can be as simple as a directory in a local filesystem or more complicated like an encryption storage service.
Show Source
-
$schema:
string
Allowed Values:
[ "config:backend" ]
The unique identifier for this JSON schema -
configuration:
configuration
Additional configuration data needed by the Backend
-
encrypted:
boolean
Default Value:
false
If true, data is encrypted at rest in the Backend -
encryptionKey:
string
Minimum Length:
1
Maximum Length:256
The key to use for encrypting data in the Backend; if not specified, a random key will be generated -
id:
string(uuid)
Unique identifier for the Backend
-
locked:
boolean
Default Value:
false
This Backend does not accept any requests -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
name:
string
Minimum Length:
1
Maximum Length:512
Human-friendly name for the Backend -
options:
array options
Minimum Number of Items:
0
Maximum Number of Items:1
Configuration options for the Backend -
readOnly:
boolean
Default Value:
false
This Backend does not accept any requests that modify data -
replaced:
array replaced
Minimum Number of Items:
1
Maximum Number of Items:512
The Backends that this backend replaced -
replacedBy:
string(uuid)
The Backend that replaced this backend
-
type:
string
Allowed Values:
[ "Files", "HAMIWS", "Legacy", "Memory", "MongoDB", "Oracle", "Wallet" ]
The type of the Backend
Example:
{
"$schema":"config:backend",
"id":"5086c4c1-4f48-4c13-9fad-095f23072a5b",
"name":"Default Filesystem",
"type":"Files",
"options":[
"duplicateNames"
],
"configuration":{
"directory":"${OGG_VAR_HOME}/lib/conf/ConfigurationService/"
}
}
Nested Schema : configuration
Additional configuration data needed by the Backend
Match Any
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : options
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
1
Configuration options for the Backend
Show Source
Nested Schema : replaced
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
512
The Backends that this backend replaced
Show Source
Nested Schema : configuration-x-anyOf[0]
Type:
Show Source
object
-
directory:
string
Minimum Length:
1
Maximum Length:1024
The directory for storing configuration data.
Nested Schema : configuration-x-anyOf[1]
Type:
Show Source
object
-
caCertificates(required):
array caCertificates
Minimum Number of Items:
1
Maximum Number of Items:128
A collection of CA certificates to use when connecting to the ensemble. -
certificatePem(required):
string
Minimum Length:
1
Maximum Length:523288
Client certificate to use when connecting to the ensemble. -
ensemble(required):
array ensemble
Minimum Number of Items:
1
Maximum Number of Items:64
Addresses of one or more members of the HAMIWS ensemble -
privateKeyPem:
string
Minimum Length:
1
Maximum Length:523288
Private key for the client certificate
Nested Schema : configuration-x-anyOf[2]
Type:
Show Source
object
-
version(required):
string
Allowed Values:
[ "21c" ]
The OGG version that this legacy backend represents.
Nested Schema : configuration-x-anyOf[3]
Type:
Show Source
object
-
collection:
string
Minimum Length:
1
Maximum Length:255
Pattern:^[^$]{0,255}$
The name of the MongoDB collection. The default value is `config:backend:id`. -
database:
string
Minimum Length:
1
Maximum Length:63
Pattern:^[^\/\\. "$*<>:|?]{1,63}$
The name of the MongoDB database. The default value is `config:configurationFile:installationId`. -
password:
string
Minimum Length:
1
Maximum Length:256
The password of the user for authenticating with the MongoDB server. -
uri(required):
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
The URI for the MongoDB server. -
username:
string
Minimum Length:
1
Maximum Length:512
The name of the user for authenticating with the MongoDB server.
Nested Schema : configuration-x-anyOf[4]
Type:
Show Source
object
-
connectionString(required):
string
Minimum Length:
1
Maximum Length:4096
Information used to identify and connect to an Oracle database. -
password:
string
Minimum Length:
1
Maximum Length:1024
The password of the user for authenticating with the Oracle database. -
tableName:
string
Minimum Length:
1
Maximum Length:512
The name of the Oracle table to use. The default value is `config:backend:id`. -
username:
string
Minimum Length:
1
Maximum Length:1024
The name of the user defined in the Oracle database.
Nested Schema : configuration-x-anyOf[5]
Type:
Show Source
object
-
data:
string
Minimum Length:
4
Maximum Length:139810134
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
The base64 encoded Oracle Wallet data - up to 100MB -
directory:
string
Minimum Length:
1
Maximum Length:1024
The directory for the Oracle Wallet -
serialized:
boolean
Default Value:
false
Indicates the Oracle Wallet should be serialized to the 'data' property
Nested Schema : caCertificates
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
128
A collection of CA certificates to use when connecting to the ensemble.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:523288
Nested Schema : ensemble
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
64
Addresses of one or more members of the HAMIWS ensemble
Show Source
Nested Schema : items
Type:
Show Source
object
-
host(required):
host
Host name or IP Address
-
port(required):
integer
Minimum Value:
1
Maximum Value:65535
IP Port number
Nested Schema : host
Host name or IP Address
Match One
Show Source
-
string
Minimum Length:
1
Maximum Length:4095
Pattern:^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
Network host name -
host-x-oneOf[1]
Network IP address
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
-
string
Minimum Length:
7
Maximum Length:15
Pattern:^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Network IPv4 address -
string
Minimum Length:
1
Maximum Length:256
Pattern:^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
Network IPv6 address
Nested Schema : items
Type:
Show Source
object
-
$schema:
Allowed Values:
[ "ogg:message" ]
-
code(required):
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20
Maximum Length:32
Pattern:^[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:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Nested Schema : items
Match Any
Show Source
-
string
Allowed Values:
[ "duplicateNames" ]
Data item names may be repeated for children of the same parent
Example Request (application/json)
{
"$schema":"config:backend",
"id":"24d9565c-3f4d-49ea-9b1e-61df05c368c3",
"name":"Temporary",
"type":"Memory"
}
Response
Supported Media Types
- application/json
201 Response
Backend created
Root Schema : RESTful API Standard Response
Type:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ]
-
links(required):
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
object
Oracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object
-
$schema:
Allowed Values:
[ "ogg:link" ]
-
description:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType:
string
Minimum Length:
6
Maximum Length:255
Pattern:^(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:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20
Maximum Length:32
Pattern:^[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:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[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:9011/services/v2/installation/configuration/backends",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9011/services/v2/installation/configuration/backends",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
],
"response":{
"$schema":"config:backend",
"id":"24d9565c-3f4d-49ea-9b1e-61df05c368c3",
"name":"Temporary",
"type":"Memory"
}
}