1. Oracle GoldenGate
  2. Tasks
  3. Service Manager
  4. Deployments

Create a Deployment

post

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

Create a new Oracle GoldenGate deployment.

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

    Name for the Oracle GoldenGate deployment.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Oracle GoldenGate Deployment
Type: object
Title: Oracle GoldenGate Deployment
Properties for an Oracle GoldenGate deployment
Show Source
  • Allowed Values: [ "ogg:deployment" ]
  • Default Value: true
    Indicates the deployment is managed by the Service Manager
  • environment
    Minimum Number of Items: 1
    Maximum Number of Items: 1024
    Additional environment variables for the deployment
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: conf
    The deployment's configuration directory
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: data
    The deployment's var/data user data directory
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: etc
    The deployment's etc configuration directory
  • Minimum Length: 1
    Maximum Length: 255
    The deployment's home directory
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: ssl
    The deployment's SSL configuration directory
  • Minimum Length: 1
    Maximum Length: 255
    Default Value: var
    The deployment's var user data directory
  • Default Value: stopped
    Allowed Values: [ "running", "stopped", "restart" ]
    Indicates the status of the deployment
Nested Schema : environment
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Additional environment variables for the deployment
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 64
    Pattern: [a-zA-Z0-9_]{1,64}
    Environment variable name
  • Minimum Length: 1
    Maximum Length: 4095
    Environment variable value
Example Request (application/json)
{
    "oggHome":"/home/oracle/oggSecondary",
    "oggEtcHome":"/home/oracle/ogg/etc",
    "enabled":false
}

Response

Supported Media Types

201 Response

The new deployment was created successfully.

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/Secondary",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11000/services/v2/deployments/Secondary",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ]
}