Skip to content

rest

Retrieving GoldenGate logs, reports, and diagnostics with the REST API

I often need to retrieve report files or logs from GoldenGate deployments, and I wanted to find ways of automating this. Hence this blog, about retrieving all available logs with GoldenGate REST API. I previously wrote about the GoldenGate log files. Some of them (extract.log, replicat.log and others) are in fact just filters of other logs (ggserr.log or restapi.log). These… 

GoldenGate 26ai AI Service: Full setup with a free Gemini key

I sometimes get asked how the new AI Service of GoldenGate 26ai works, and the best way to show it is to see it in action. In this blog, I will set up the AI Service with Google Gemini, using a free API key in Google AI Studio. Most of what will be said here can be applied to the… 

Rename a GoldenGate Extract with the REST API

In a previous blog, I went through the full procedure of renaming a GoldenGate extract from the adminclient. I included all necessary steps to avoid missing transactions. Doing this by hand is completely fine, but if you do it often, or want to remove the risk of a typo on an SCN, I have another solution for you. In this… 

GoldenGate REST API Python client now on pip

In a previous post, I shared the OGGRestAPI Python client I built for the GoldenGate REST API. Since then, I kept using it on production deployments, fixing it and adding new features along the way. It felt like the right time to stop asking people to copy a .py file into their project, so I published it to PyPI. You… 

NGINX secured distribution path with GoldenGate REST API

In a previous blog, I presented how to set up a distribution path between two GoldenGate deployments both secured with NGINX. The method I used there was purely through the Web UI. But GoldenGate also exposes a full REST API, and everything you can do in the UI can be done through the API as well, which is useful for… 

GoldenGate 26ai out-of-place patching with Python

I already covered out-of-place patching from the web UI, but patching tasks should be automated, and clicking through the same screens for every deployment can get repetitive. Let’s do the exact same out-of-place patch of a GoldenGate Microservices Architecture deployment, this time entirely with the REST API. Every step below shows two ways to make the same call: Installing the… 

Checking long running transactions in GoldenGate

When doing complex operations with GoldenGate, checking for long running transactions is mandatory if you don’t want to miss transactions. Let’s look at two ways of retrieving such information, first with the adminclient, and then with the REST API. When and why should I worry about long running transactions ? In a standard extract life-cycle, you should not be worrying… 

Simplified distribution path creation in GoldenGate 26.3

The 23.26.3.0.0 release update of GoldenGate 26ai (July 2026) ships a small but welcome usability change, listed in the New Enhancements section of the release notes: Bug 39415027: Generic – Simplified Distribution and Receiver Service Path Configuration Enhanced the Create Distribution and Receiver Service Paths experience by introducing Simple and Advanced configuration modes. The simplified view displays only the required settings by default, while… 

Creating path connections with GoldenGate REST API

When automating your GoldenGate deployment management, you might want to create path connections with the GoldenGate REST API. This is an important aspect when connecting GoldenGate deployments with distribution paths. A first step towards this is to create a path connection on the same deployment as the distribution server where the distribution path will run. In the GoldenGate web UI,… 

Create a new GoldenGate deployment with the REST API

Is it possible to create a new GoldenGate deployment with the REST API ? This is the question I will try to answer in this blog, based on my experience with the REST API. I will dive in what is done by the oggca.sh script when adding a new deployment and see if we can replicate this with the REST… 

Production-ready GoldenGate REST client in Python

Updated in June 2026, based on the latest version of the client. In this blog, I provide GoldenGate administrators with a fully working, production-ready Python client to efficiently handle GoldenGate REST API calls. From extract creation to user management, it has never been easier to manage and monitor your GoldenGate deployments ! Basic OGGRestAPI Python class In a previous blog… 

Querying GoldenGate REST API log efficiently

In this blog post, I will guide you on how to query the restapi.log file of your GoldenGate deployments more efficiently. These logs are a valuable source of information for GoldenGate administrators but are unfortunately not easy to analyze. In fact, their format is not really suited for a complex analysis. With what I present here, you could improve the…