1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Service Manager
  4. Services

Create a Service

post

/services/{version}/deployments/{deployment}/services/{service}

Required Role: Administrator

Add a new service to a deployment. An application with the service name must exist for this request to succeed.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Oracle GoldenGate Service Configuration
Type: object
Title: Oracle GoldenGate Service Configuration
Configuration data for an OGG Microservice
Show Source
  • Allowed Values: [ "ogg:service" ]
  • config
    Service configuration data
  • Default Value: false
    Force the configuration data
  • Default Value: true
    Indicates the service is critical to the deployment
  • Default Value: true
    Indicates the service is managed by the Service Manager
  • Minimum Length: 36
    Maximum Length: 36
    Default Value: b8c774c1-76c6-4a0a-bd23-da6b8c5c38dc
    Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
    An identifier that uniquely identifies this service
  • Default Value: false
    Indicates the service is locked by a security administrator and cannot be started
  • Default Value: false
    Start the service in quiet mode
  • restart
    Control how the service is restarted if it terminates
  • Default Value: stopped
    Allowed Values: [ "starting", "running", "stopped", "restart", "killed", "abended" ]
    Indicates the status of the service
Nested Schema : config
Type: object
Service configuration data
Show Source
Nested Schema : restart
Type: object
Control how the service is restarted if it terminates
Default Value: { "enabled":true, "onSuccess":true, "delay":"0", "retries":"9", "window":"60", "disableOnFailure":true }
Show Source
  • Allowed Values: [ "ogg:taskRestart" ]
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 0
    The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.
  • Default Value: true
    If true, the task is disabled when it fails all execution attempts in an execution window.
  • Default Value: true
    If set, the task can be restarted if it terminates.
  • Minimum Value: 0
    Maximum Value: 3600
    The number of times the task failed in the current window.
  • Default Value: true
    If false, the task is only restarted if it fails.
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 9
    The maximum number of times the task should be restarted before aborting retry efforts.
  • Minimum Value: 0
    Maximum Value: 604800
    Default Value: 60
    The window of time, in seconds, during which retries are counted.
Nested Schema : authorizationDetails
Type: object
Authorization configuration details.
Show Source
  • common
    Common authorization configuration settings.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Width of the expiration window in seconds.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 3600
    Duration of the authorizations.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 1800
    The maximum number of seconds an unexpired authorization session may be inactive before expiring. A session's inactivity time will be unlimited when sessionInactiveSeconds is set to 0.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 12
    The maximum number of times unexpired authorization sessions may be reauthorized. Session reauthorization request are not allowed when sessionReauthorizationLimit is set to 0.
  • Default Value: false
    Enable the use of moving expiration window over fix expiration time value.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 300
    The number of seconds for which an authorization digest remains valid.
Nested Schema : contentUrlRewrite
Incoming URL rewriting rules.
Match One
Show Source
  • Minimum Length: 0
    Maximum Length: 10240
    A comma-delimited key value string of rewriting rules
  • contentUrlRewrite-x-oneOf[1]
    Minimum Number of Items: 1
    Maximum Number of Items: 2048
    An array of rewriting rules.
Nested Schema : cors
Cross-Origin Resource Sharing
Match One
Show Source
Nested Schema : hstsDetails
Defines the HTTP Strict-Transport-Security (HSTS) policy parameters
Match One
Show Source
Nested Schema : network
Type: object
Network configuration
Show Source
Nested Schema : securityDetails
Type: object
Detailed security configuration.
Show Source
Nested Schema : common
Type: object
Common authorization configuration settings.
Show Source
Nested Schema : allow
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 5
Authorization modes allowed.
Show Source
  • Allowed Values: [ "Basic", "Digest-SHA-256", "Digest", "x-Cert", "Bearer" ]
    Name of authorization modes allowed.
Nested Schema : contentUrlRewrite-x-oneOf[1]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2048
An array of rewriting rules.
Show Source
Nested Schema : items
Type: object
URL rewriting rule.
Show Source
Nested Schema : cors-x-oneOf[0]
Type: object
Allow anonymous access from any origin
Show Source
Nested Schema : cors-x-oneOf[1]
Type: object
Allow credentialed access from a specific origin
Show Source
Nested Schema : hstsDetails-x-oneOf[0]
Type: object
HSTS policy object.
Show Source
  • Default Value: true
    Option indicating that the target domain's subdomain should be included when evaluating the HSTS policy.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Maximum time in seconds the HTST policy should remain in effect.
Nested Schema : serviceListeningPort
Port number that the service will listen on
Match One
Show Source
Nested Schema : serviceListeningPort-x-oneOf[0]
Listener TCP/IP port number
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
  • Minimum Length: 1
    Maximum Length: 32
Nested Schema : serviceListeningPort-x-oneOf[1]
Type: object
Port number for a specific IP address or host name
Show Source
Match Any
Show Source
Nested Schema : serviceListeningPort-x-oneOf[2]
Type: object
Port number for a specific network interface
Show Source
Nested Schema : serviceListeningPort-x-oneOf[3]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 32
Array of listener specifications
Show Source
Nested Schema : address
IP address for listener
Match One
Show Source
  • 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
  • address-x-oneOf[1]
    Network IP address
Nested Schema : name
Host name for listener
Match One
Show Source
  • 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
  • name-x-oneOf[1]
    Network IP address
Nested Schema : port
Listener TCP/IP port number
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
  • Minimum Length: 1
    Maximum Length: 32
Nested Schema : address-x-oneOf[1]
Network IP address
Match One
Show Source
  • 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
  • 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 : name-x-oneOf[1]
Network IP address
Match One
Show Source
  • 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
  • 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 : port
Listener TCP/IP port number
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
  • Minimum Length: 1
    Maximum Length: 32
Nested Schema : items
Match Any
Show Source
Nested Schema : items-x-anyOf[0]
Type: object
Port number for a specific IP address or host name
Show Source
Match Any
Show Source
Nested Schema : items-x-anyOf[1]
Type: object
Port number for a specific network interface
Show Source
Nested Schema : address
IP address for listener
Match One
Show Source
  • 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
  • address-x-oneOf[1]
    Network IP address
Nested Schema : name
Host name for listener
Match One
Show Source
  • 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
  • name-x-oneOf[1]
    Network IP address
Nested Schema : port
Listener TCP/IP port number
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
  • Minimum Length: 1
    Maximum Length: 32
Nested Schema : address-x-oneOf[1]
Network IP address
Match One
Show Source
  • 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
  • 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 : name-x-oneOf[1]
Network IP address
Match One
Show Source
  • 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
  • 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 : port
Listener TCP/IP port number
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
  • Minimum Length: 1
    Maximum Length: 32
Nested Schema : network
Type: object
Network security configuration.
Show Source
Nested Schema : common
Type: object
Common network security configuration.
Show Source
  • Default Value: false
    Indicates whether a FIPS-140 compliant implementation module should be used.
  • Allowed Values: [ "OracleSSL" ]
    Security implementation identifier.
Nested Schema : inbound
Type: object
Network security configuration for inbound requests from clients.
Show Source
  • Allowed Values: [ "server_only", "clientOptional_server", "client_server", "client_only", "anonymous" ]
    Defines the authorization mode to use when accepting secured network connections.
  • certACL
    Minimum Number of Items: 1
    Maximum Number of Items: 255
    Array policies for accepting allowing or denying acceptance of a peer certificate.
  • cipherSuites
    Defines the cipher-suites that may be used when establishing secure network connections.
  • Default Value: true
    Indicates whether Certificate Revocation List handling is enabled.
  • Minimum Length: 5
    Maximum Length: 4096
    Pattern: ^file:.*$
    Defines the path to the CRL file.
  • Allowed Values: [ "1_0", "1_0_Or_3_0", "1_1", "1_1_Or_1_0", "1_1_Or_1_0_Or_3_0", "1_1_Or_3_0", "1_2", "1_2_Or_1_0", "1_2_Or_1_0_Or_3_0", "1_2_Or_1_1", "1_2_Or_1_1_Or_1_0", "1_2_Or_1_1_Or_1_0_Or_3_0", "1_2_Or_1_1_Or_3_0", "1_2_Or_3_0", "3_0", "3_0_Only", "3_0_With_2_0_Hello" ]
    Defines the protocol version to use and accept when establishing secure network connections.
  • Allowed Values: [ "server" ]
    Defines the role the application is assuming.
  • sessionCacheDetails
    Defines the control limits for session caching.
  • Default Value: true
    Indicates whether session caching is enabled.
  • Minimum Length: 5
    Maximum Length: 4096
    Pattern: ^file:.*$
    Defines the path to an Oracle wallet.
  • Minimum Length: 0
    Maximum Length: 255
    Defines the Oracle wallet password if the wallet is declared as autologin.
Nested Schema : outbound
Type: object
Network security configuration for outbound requests to servers.
Show Source
  • Allowed Values: [ "server_only", "clientOptional_server", "client_server", "client_only", "anonymous" ]
    Defines the authorization mode to use when accepting secured network connections.
  • cipherSuites
    Defines the cipher-suites that may be used when establishing secure network connections.
  • Default Value: true
    Indicates whether Certificate Revocation List handling is enabled.
  • Minimum Length: 5
    Maximum Length: 4096
    Pattern: ^file:.*$
    Defines the path to the CRL file.
  • Allowed Values: [ "1_0", "1_0_Or_3_0", "1_1", "1_1_Or_1_0", "1_1_Or_1_0_Or_3_0", "1_1_Or_3_0", "1_2", "1_2_Or_1_0", "1_2_Or_1_0_Or_3_0", "1_2_Or_1_1", "1_2_Or_1_1_Or_1_0", "1_2_Or_1_1_Or_1_0_Or_3_0", "1_2_Or_1_1_Or_3_0", "1_2_Or_3_0", "3_0", "3_0_Only", "3_0_With_2_0_Hello" ]
    Defines the protocol version to use and accept when establishing secure network connections.
  • Allowed Values: [ "client" ]
    Defines the role the application is assuming.
  • sessionCacheDetails
    Defines the control limits for session caching.
  • Default Value: true
    Indicates whether session caching is enabled.
  • Minimum Length: 5
    Maximum Length: 4096
    Pattern: ^file:.*$
    Defines the path to an Oracle wallet.
  • Minimum Length: 0
    Maximum Length: 255
    Defines the Oracle wallet password if the wallet is declared as autologin.
Nested Schema : certACL
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 255
Array policies for accepting allowing or denying acceptance of a peer certificate.
Show Source
Nested Schema : cipherSuites
Defines the cipher-suites that may be used when establishing secure network connections.
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: ^((?!anon|RC4|NULL|3DES).)*$
    Regular expression that qualifies the set of cipher-suites to select for use when establishing secure network connections.
  • cipherSuites-x-oneOf[1]
    Minimum Number of Items: 1
    Maximum Number of Items: 36
    Array of discrete cipher-suite identifiers that may be used when establishing secure network connections.
Nested Schema : sessionCacheDetails
Type: object
Defines the control limits for session caching.
Show Source
  • Minimum Value: 1
    Maximum Value: 4294967295
    Default Value: 20480
    The maximum number of sessions to cache.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 1800
    The number of seconds before a session might be purged from the session cache.
Nested Schema : items
Type: object
Certificate Access Control List Policy.
Show Source
Nested Schema : cipherSuites-x-oneOf[1]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 36
Array of discrete cipher-suite identifiers that may be used when establishing secure network connections.
Show Source
  • Allowed Values: [ "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256", "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA", "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA", "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384", "TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_RSA_WITH_AES_128_GCM_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA", "TLS_RSA_WITH_AES_256_CBC_SHA256", "TLS_RSA_WITH_AES_256_GCM_SHA384" ]
    Cipher-suite identifier
Nested Schema : cipherSuites
Defines the cipher-suites that may be used when establishing secure network connections.
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: ^((?!anon|RC4|NULL|3DES).)*$
    Regular expression that qualifies the set of cipher-suites to select for use when establishing secure network connections.
  • cipherSuites-x-oneOf[1]
    Minimum Number of Items: 1
    Maximum Number of Items: 36
    Array of discrete cipher-suite identifiers that may be used when establishing secure network connections.
Nested Schema : sessionCacheDetails
Type: object
Defines the control limits for session caching.
Show Source
  • Minimum Value: 1
    Maximum Value: 4294967295
    Default Value: 20480
    The maximum number of sessions to cache.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 1800
    The number of seconds before a session might be purged from the session cache.
Nested Schema : cipherSuites-x-oneOf[1]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 36
Array of discrete cipher-suite identifiers that may be used when establishing secure network connections.
Show Source
  • Allowed Values: [ "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256", "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA", "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA", "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384", "TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_RSA_WITH_AES_128_GCM_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA", "TLS_RSA_WITH_AES_256_CBC_SHA256", "TLS_RSA_WITH_AES_256_GCM_SHA384" ]
    Cipher-suite identifier
Example Request (application/json)
{
    "$schema":"ogg:service",
    "config":{
        "network":{
            "serviceListeningPort":"11001"
        },
        "security":false,
        "authorizationEnabled":true,
        "defaultSynchronousWait":"30",
        "asynchronousOperationEnabled":true,
        "legacyProtocolEnabled":true,
        "taskManagerEnabled":true
    },
    "enabled":false
}
Back to Top

Response

Supported Media Types

201 Response

The new services was successfully added to the deployment.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
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: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • 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.
  • 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:11000/services/v2/deployments/Local/services/adminsrvr",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11000/services/v2/deployments/Local/services/adminsrvr",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ]
}
Back to Top