OGG-08116 when creating a connection with GoldenGate REST API

When playing around with the GoldenGate REST API, you might have encountered the OGG-08116 error. It happens when using the Create Connection REST API call, with the following endpoint given in the GoldenGate documentation.

The OGG-08116 error is defined as such in the documentation:

OGG-08116: Connections with names of the form 'domain.alias' are read-only

Cause: Connections with names of the form domain.alias are automatically created from credentials and are read-only.

Action: Remove the period from the connection name

So what is the problem exactly ? When navigating through the GoldenGate deployment’s web UI, you create a connection in the DB Connections tab (see below). However, the Create connection API endpoint doesn’t serve the same purpose !

The correct endpoint you should use to create a GoldenGate connection is actually named Create Alias.

And with this one, everything works fine ! I give below a working example of a Python script to create a connection/alias with the GoldenGate REST API. If you want to learn more about building GoldenGate API calls with Python, I wrote a blog on the topic.

import requests

alias = "cdb01"
domain = "OracleGoldenGate"
url = f"http://vmogg:7810/services/v2/credentials/{domain}/{alias}"
auth = ("ogg_user", "ogg_password")
data = {
    "userid": "c##oggadmin@vmora:1521/CDB01",
    "password": "your_password"
}

result = requests.post(url, auth=auth, json=data)

Running the requests command and checking in the web UI, we can see the newly created alias.

>>> result.ok
True
>>> result.json()
{'$schema': 'api:standardResponse', 'links': [{'rel': 'canonical', 'href': 'https://vmogg:7810/services/v2/credentials/OracleGoldenGate/cdb01', 'mediaType': 'application/json'}, {'rel': 'self', 'href': 'https://vmogg:7810/services/v2/credentials/OracleGoldenGate/cdb01', 'mediaType': 'application/json'}], 'messages': [{'$schema': 'ogg:message', 'title': 'Credential store altered.', 'code': 'OGG-15114', 'severity': 'INFO', 'issued': '2026-01-28T20:41:56Z', 'type': 'https://docs.oracle.com/en/middleware/goldengate/core/23.26/error-messages/'}]}

Keep in mind that the Create Connection endpoint is read-only, and should never be used !