How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Golden Gate API

The goldenGate API from Oracle — 79 operation(s) for goldengate.

Oracle Golden Gate API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 98 operations across 79 paths, and defines 145 schemas. It is described by OpenAPI 3.2.0, at version 20200407.

Requests are made against 2 base URLs: http://127.0.0.1/20200407, https://127.0.0.1/20200407.

98 operations 79 paths 145 schemas 7 DELETE36 GET50 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20200407
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 98

Across 79 paths, the API surfaces 98 operations — 7 DELETE, 36 GET, 50 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

goldenGate 98
GET
/aiModels
Lists AI models for the specified provider.
ListAiModels 5 params → 200400401404429500default
GET
/aiProviders
Lists supported AI providers and their models.
ListAiProviders 2 params → 200400401404429500default
GET
/connectionAssignments
Returns a list of the Connections Assignments in the compartment.
ListConnectionAssignments 12 params → 200400401404429500default
POST
/connectionAssignments
Creates a new Connection Assignment.
CreateConnectionAssignment 3 params body → 201400401404409429500default
DELETE
/connectionAssignments/{connectionAssignmentId}
Deletes a Connection Assignment.
DeleteConnectionAssignment 4 params → 202400401404409412429500
GET
/connectionAssignments/{connectionAssignmentId}
Retrieves a Connection Assignment.
GetConnectionAssignment 2 params → 200400401404429500default
POST
/connectionAssignments/{connectionAssignmentId}/actions/test
Tests DB/service connectivity from a deployment.
TestConnectionAssignment 4 params body → 200400401404409412429500
GET
/connections
Returns a list of the Connections in the compartment.
ListConnections 14 params → 200400401404429500default
POST
/connections
Creates a new Connection.
CreateConnection 2 params body → 201400401404409429500default
DELETE
/connections/{connectionId}
Deletes a Connection.
DeleteConnection 4 params → 202400401404409412429500
GET
/connections/{connectionId}
Retrieves a Connection.
GetConnection 3 params → 200400401404429500default
PUT
/connections/{connectionId}
Update the Connection identified by the id.
UpdateConnection 4 params body → 202400401404412429500default
POST
/connections/{connectionId}/actions/addLock
Adds a lock to a Connection resource.
AddConnectionLock 4 params → 200400401404412429500default
POST
/connections/{connectionId}/actions/changeCompartment
Moves the Connection to a different compartment.
ChangeConnectionCompartment 4 params body → 202400401404409412429500
POST
/connections/{connectionId}/actions/changeSubscription
Associate a GoldenGate connection with a different subscription.
ChangeConnectionSubscription 4 params body → 202400401404409412429500
POST
/connections/{connectionId}/actions/migrate
Migrate Connection attributes.
MigrateConnection 4 params body → 202400401404412429500default
POST
/connections/{connectionId}/actions/refresh
Refresh external Connection attributes.
RefreshConnection 4 params body → 202400401404412429500default
POST
/connections/{connectionId}/actions/removeLock
Removes a lock to a Connection resource.
RemoveConnectionLock 4 params → 200400401404412429500default
GET
/databaseRegistrationsdeprecated
Returns a list of the DatabaseRegistrations in the compartment.
ListDatabaseRegistrations 8 params → 200400401404429500default
POST
/databaseRegistrationsdeprecated
Creates a new DatabaseRegistration.
CreateDatabaseRegistration 2 params body → 201400401404409429500default
DELETE
/databaseRegistrations/{databaseRegistrationId}deprecated
Deletes a DatabaseRegistration.
DeleteDatabaseRegistration 3 params → 202400401404409412429500
GET
/databaseRegistrations/{databaseRegistrationId}deprecated
Retrieves a DatabaseRegistration.
GetDatabaseRegistration 2 params → 200400401404429500default
PUT
/databaseRegistrations/{databaseRegistrationId}deprecated
Update the DatabaseRegistration identified by the id.
UpdateDatabaseRegistration 3 params body → 202400401404412429500default
POST
/databaseRegistrations/{databaseRegistrationId}/actions/changeCompartmentdeprecated
Moves the DatabaseRegistration to a different compartment.
ChangeDatabaseRegistrationCompartment 4 params body → 202400401404409412429500
GET
/deploymentBackups
Lists the DeploymentBackups in a compartment.
ListDeploymentBackups 9 params → 200400401404429500default
POST
/deploymentBackups
Creates a new DeploymentBackup
CreateDeploymentBackup 2 params body → 201400401404409429500default
DELETE
/deploymentBackups/{deploymentBackupId}
Deletes a DeploymentBackup.
DeleteDeploymentBackup 4 params → 202400401404409412429500
GET
/deploymentBackups/{deploymentBackupId}
Retrieves a DeploymentBackup
GetDeploymentBackup 2 params → 200400401404429500default
PUT
/deploymentBackups/{deploymentBackupId}
Modifies a Deployment Backup
UpdateDeploymentBackup 4 params body → 200400401404412429500default
POST
/deploymentBackups/{deploymentBackupId}/actions/addLock
Adds a lock to a DeploymentBackup resource.
AddDeploymentBackupLock 4 params → 200400401404412429500default
POST
/deploymentBackups/{deploymentBackupId}/actions/cancel
Cancels deployment backup creation process
CancelDeploymentBackup 5 params body → 202400401404409412429500
POST
/deploymentBackups/{deploymentBackupId}/actions/changeCompartment
Moves the DeploymentBackup into a different compartment
ChangeDeploymentBackupCompartment 5 params body → 204400401404409412429500
POST
/deploymentBackups/{deploymentBackupId}/actions/copyToBucket
Creates a copy of a Deployment Backup.
CopyDeploymentBackup 4 params body → 201400401404409412429500
POST
/deploymentBackups/{deploymentBackupId}/actions/removeLock
Removes a lock to a DeploymentBackup resource.
RemoveDeploymentBackupLock 4 params → 200400401404412429500default
POST
/deploymentBackups/{deploymentBackupId}/actions/restore
Restores a deployment from the Object Store
RestoreDeployment 5 params body → 202400401404409412429500
GET
/deploymentEnvironments
Get available deployment environment specific meta-data.
ListDeploymentEnvironments 6 params → 200400401404429500default
GET
/deploymentTypes
Get available deployment type specific meta-data.
ListDeploymentTypes 9 params → 200400401404429500default
GET
/deploymentUpgrades
Lists the Deployment Upgrades in a compartment.
ListDeploymentUpgrades 9 params → 200400401404429500default
GET
/deploymentUpgrades/{deploymentUpgradeId}
Retrieves a deployment upgrade.
GetDeploymentUpgrade 2 params → 200400401404429500default
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/cancel
Cancels a DeploymentUpgrade.
CancelDeploymentUpgrade 4 params body → 200400401404409412429500
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/cancelSnooze
Cancel snooze of a DeploymentUpgrade.
CancelSnoozeDeploymentUpgrade 4 params body → 200400401404409412429500
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/reschedule
Reschedules a DeploymentUpgrade.
RescheduleDeploymentUpgrade 4 params body → 200400401404409412429500
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/rollback
Rollback a DeploymentUpgrade.
RollbackDeploymentUpgrade 5 params body → 202400401404409412429500
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/snooze
Snooze a DeploymentUpgrade.
SnoozeDeploymentUpgrade 4 params body → 200400401404409412429500
POST
/deploymentUpgrades/{deploymentUpgradeId}/actions/upgrade
Upgrade a deployment to specific version.
UpgradeDeploymentUpgrade 5 params body → 202400401404409412429500
GET
/deploymentVersions
Get available deployment versions.
ListDeploymentVersions 8 params → 200400401404429500default
GET
/deployments
Lists the Deployments in a compartment.
ListDeployments 14 params → 200400401404429500default
POST
/deployments
Creates a new Deployment.
CreateDeployment 2 params body → 201400401404409429500default
DELETE
/deployments/{deploymentId}
Deletes the Deployment.
DeleteDeployment 4 params → 202400401404409412429500
GET
/deployments/{deploymentId}
Retrieves a deployment.
GetDeployment 2 params → 200400401404429500default
PUT
/deployments/{deploymentId}
Modifies a Deployment
UpdateDeployment 4 params body → 202400401404412429500default
POST
/deployments/{deploymentId}/actions/addLocalPeer
Add a new deployment local peer
AddDeploymentLocalPeer 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/addLock
Adds a lock to a Deployment resource.
AddDeploymentLock 4 params → 200400401404412429500default
POST
/deployments/{deploymentId}/actions/changeCompartment
Moves the Deployment into a different compartment
ChangeDeploymentCompartment 5 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/changeSubscription
Associate a GoldenGate deployment with a different subscription.
ChangeDeploymentSubscription 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/collectDiagnostics
Collects the diagnostic of a Deployment
CollectDeploymentDiagnostic 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/exportWallet
Export the OGG wallet from the deployment to OCI vault
ExportDeploymentWallet 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/generateDisasterRecoveryPrecheckReport
Disaster Recovery precheck.
GenerateDisasterRecoveryPrecheckReport 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/generateLibraryUrl
Generates a Pre-Authenticated Request Object URL to the DB2 for z/OS library.
GenerateLibraryUrl 4 params body → 200400401404409412429500
POST
/deployments/{deploymentId}/actions/importWallet
Imports an OGG wallet to the Deployment
ImportDeploymentWallet 5 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/removeLocalPeer
Removes a local peer
RemoveDeploymentLocalPeer 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/removeLock
Removes a lock to a Deployment resource.
RemoveDeploymentLock 4 params → 200400401404412429500default
POST
/deployments/{deploymentId}/actions/start
Starts a Deployment
StartDeployment 5 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/stop
Stops a Deployment.
StopDeployment 5 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/switchover
Switchover to the deployment peer
SwitchoverDeploymentPeer 4 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/upgrade
Upgrade a Deployment to different version.
UpgradeDeployment 5 params body → 202400401404409412429500
POST
/deployments/{deploymentId}/actions/walletExists
Checks if a wallet is already present in the deployment
DeploymentWalletExists 4 params body → 200400401404409412429500
GET
/deployments/{deploymentId}/certificates
Returns a list of certificates from truststore.
ListCertificates 7 params → 200400401404429500default
POST
/deployments/{deploymentId}/certificates
Creates a new certificate to truststore.
CreateCertificate 4 params body → 202400401404409429500default
DELETE
/deployments/{deploymentId}/certificates/{certificateKey}
Deletes the certificate from truststore.
DeleteCertificate 5 params → 202400401404409412429500
GET
/deployments/{deploymentId}/certificates/{certificateKey}
Retrieves a Certificate.
GetCertificate 3 params → 200400401404429500default
GET
/deployments/{deploymentId}/deploymentWalletsOperations
Returns a list of the wallets export/import operations to/from a deployment.
ListDeploymentWalletsOperations 7 params → 200400401404429500default
GET
/deployments/{deploymentId}/disasterRecoveryPrecheckReport
Returns DR precheck report for a standby peer.
GetDisasterRecoveryPrecheckReport 4 params → 200400401404429500default
GET
/deployments/{deploymentId}/peers
Lists the local and remote peers in a deployment.
ListDeploymentPeers 8 params → 200400401404429500default
GET
/messages
Returns a list of the DeploymentMessages for a deployment.
ListMessages 4 params → 200400401404429500default
GET
/pipelines
Returns a list of the Pipelines in the compartment.
ListPipelines 9 params → 200400401404429500default
POST
/pipelines
Creates a new pipeline.
CreatePipeline 2 params body → 201400401404409429500default
POST
/pipelines/actions/clone
Creates a clone of the pipeline.
ClonePipeline 4 params body → 202400401404409412429500
DELETE
/pipelines/{pipelineId}
Deletes a Pipeline.
DeletePipeline 4 params → 202400401404409412429500
GET
/pipelines/{pipelineId}
Retrieves a Pipeline details.
GetPipeline 2 params → 200400401404429500default
PUT
/pipelines/{pipelineId}
Update the Pipeline identified by the pipeline id.
UpdatePipeline 4 params body → 202400401404412429500default
POST
/pipelines/{pipelineId}/actions/changeCompartment
Moves the Pipeline to a different compartment.
ChangePipelineCompartment 5 params body → 202400401404409412429500
POST
/pipelines/{pipelineId}/actions/collectDiagnostics
Collects diagnostics for the pipeline
CollectPipelineDiagnostic 4 params body → 202400401404409412429500
POST
/pipelines/{pipelineId}/actions/pause
pauses the pipeline.
PausePipeline 5 params body → 202400401404409412429500
POST
/pipelines/{pipelineId}/actions/start
Starts the pipeline for data replication.
StartPipeline 5 params body → 202400401404409412429500
POST
/pipelines/{pipelineId}/actions/stop
Stops the pipeline for data replication.
StopPipeline 5 params body → 202400401404409412429500
POST
/pipelines/{pipelineId}/actions/testConnection
Tests pipeline connections against pipeline to verify the connectivity.
TestPipelineConnection 4 params body → 200400401404409412429500
GET
/pipelines/{pipelineId}/initializationSteps
Retrieves a Pipeline recipe steps and its progress details.
ListPipelineInitializationSteps 2 params → 200400401404429500default
GET
/pipelines/{pipelineId}/runningProcesses
Retrieves a Pipeline's running replication process's status like Capture/Apply.
ListPipelineRunningProcesses 6 params → 200400401404429500default
GET
/pipelines/{pipelineId}/schemaTables
Get an array of tables under the given schemas passed as required source and target query params of the pipeline.
ListPipelineSchemaTables 9 params → 200400401404429500default
GET
/pipelines/{pipelineId}/schemas
Get an array of schemas based on mapping rules for a pipeline.
ListPipelineSchemas 7 params → 200400401404429500default
GET
/recipes
Get available recipes supported by GoldenGate.
ListRecipes 8 params → 200400401404429500default
GET
/trailFilesdeprecated
Returns a list of the TrailFiles for a deployment.
ListTrailFiles 8 params → 200400401404429500default
GET
/trailSequencesdeprecated
Returns a list of the Trail Sequences for a deployment.
ListTrailSequences 9 params → 200400401404429500default
GET
/workRequests
Lists the work requests in the compartment.
ListWorkRequests 5 params → 200400401404429500default
GET
/workRequests/{workRequestId}
Retrieves a work request.
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors.
ListWorkRequestErrors 4 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs.
ListWorkRequestLogs 4 params → 200400401404429500default

Schemas 145

The contract defines 145 schemas that model the data the API accepts and returns. The most detailed are Deployment (57 properties), DeploymentSummary (37 properties), CreateDeploymentDetails (31 properties), DeploymentUpgrade (29 properties). Each schema is shown below with its type and property counts.

UpdateMaintenanceWindowDetails
object
Defines the maintenance window for update operation, when automatic actions can be performed.
2 properties 2 required
ChangeDeploymentBackupCompartmentDetails
object
The new compartment for a DeploymentBackup.
1 property 1 required
CancelSnoozeDeploymentUpgradeDetails
object
The information about snooze canceling.
1 property 1 required
PipelineSummary
object
Summary details of the pipeline.
20 properties 12 required
DisasterRecoveryPrecheckResult
object
A single precheck result.
8 properties 7 required
ChangeConnectionSubscriptionDetails
The configuration details for associating the GoldenGate connection resource with a different subscription.
ClonePipelineDetails
object
Details for a pipeline clone.
8 properties 4 required
CollectPipelineDiagnosticDetails
object
Details for collecting pipeline diagnostics
3 properties 2 required
DisasterRecoveryPrecheckReport
object
DR precheck result for standby peer in the specified placement (availabilityDomain and faultDomain).
4 properties 4 required
PipelineSchemaTableCollection
object
List of source or target schema tables of a pipeline's assigned connection.
3 properties 1 required
DeploymentUpgradeSummary
object
Summary of the Deployment Upgrade.
29 properties 4 required
PipelineSchemaCollection
object
The list of schemas present in the source/target connection database of a pipeline.
1 property 1 required
GroupToRolesMappingDetails
object
Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM dep…
4 properties 1 required
ResourceLock
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
4 properties 1 required
ImportDeploymentWalletDetails
object
Metadata required to import wallet to deployment
6 properties 2 required
PipelineRunningProcessSummary
object
Each replication process and their summary details.
5 properties 5 required
CreateDeploymentBackupDetails
object
The information about a new DeploymentBackup.
10 properties 6 required
RemoveResourceLockDetails
object
Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the reso…
1 property 1 required
SnoozeDeploymentUpgradeDetails
object
The information about the snooze for a deployment.
1 property 1 required
DeploymentCollection
object
A list of Deployments.
1 property 1 required
DeploymentVersionCollection
object
The list of DeploymentVersionSummary objects.
1 property 1 required
CreateDatabaseRegistrationDetails
object
The information about a new DatabaseRegistration.
18 properties 6 required
DeploymentPeerCollection
object
A list of DeploymentPeers.
1 property 1 required
DatabaseRegistrationSummary
object
Summary of the DatabaseRegistration.
19 properties 4 required
StopPipelineDetails
object
Details for a pipeline stop.
1 property 1 required
DeploymentEnvironmentSummary
object
The metadata specific to a production or development/testing environment.
10 properties 9 required
CreateConnectionDetails
object
The information about a new Connection.
16 properties 3 required
TestConnectionAssignmentDetails
object
The information about testing the assigned connection.
1 property 1 required
PipelineSchemaTableSummary
object
Summary of source or target schema tables of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched so…
2 properties 2 required
SwitchoverDeploymentPeerDetails
object
The information about switching to deployment peer.
3 properties 2 required
ChangeSubscriptionDetails
object
The configuration details for associating the resource with a different subscription.
2 properties
StartPipelineDetails
object
Details with which to start a pipeline.
1 property 1 required
DeploymentUpgradeCollection
object
A list of Deployment Upgrades.
1 property 1 required
UpgradeDeploymentDetails
object
The information about the Upgrade for a Deployment.
1 property 1 required
CreateMaintenanceWindowDetails
object
Defines the maintenance window for create operation, when automatic actions can be performed.
2 properties 2 required
UpdateMaintenanceConfigurationDetails
object
Defines the maintenance configuration for update operation.
5 properties
ChangeDeploymentSubscriptionDetails
The configuration details for associating the GoldenGate deployment resource with a different subscription.
DeploymentWalletExistsDetails
object
The information to check if a wallet is present in the Deployment.
1 property 1 required
Certificate
object
Certificate data.
20 properties 20 required
ExportDeploymentWalletDetails
object
Metadata required to export wallet from deployment
5 properties 3 required
MaintenanceConfiguration
object
Attributes for configuring automatic deployment maintenance.
5 properties 4 required
TrailFileSummary
object
Summary of the TrailFiles.
9 properties 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
UpdateBackupScheduleDetails
object
Defines the backup schedule details for update operation.
6 properties
UpdatePipelineDetails
string
Information with which to update a pipeline.
9 properties
DeploymentBackupCollection
object
A list of DeploymentBackups.
1 property 1 required
UpdateDeploymentBackupDetails
object
The information to use to update a Deployment Backup.
2 properties
TechnologyType
string
The technology type.
DeploymentTypeCollection
object
The list of DeploymentTypeDescriptor objects.
1 property 1 required
DeploymentBackup
object
A backup of the current state of the GoldenGate deployment. Can be used to restore a deployment, or create a new deployment with that state as the starting dep…
24 properties 6 required
TrailFileCollection
object
A list of TrailFiles.
2 properties 2 required
ChangeConnectionCompartmentDetails
object
The new compartment for a Connection.
1 property 1 required
CreateConnectionAssignmentDetails
object
The information about a new Connection Assignment.
2 properties 2 required
ConnectionAssignmentCollection
object
List of connection summary objects.
1 property 1 required
LicenseModel
string
The Oracle license model that applies to a Deployment.
CreateOggDeploymentDetails
object
Deployment Data for creating an OggDeployment
11 properties
DatabaseRegistration
object
Represents the metadata description of a database used by deployments in the same compartment.
25 properties 7 required
Pipeline
object
Represents the metadata details of a pipeline in the same compartment.
22 properties 12 required
RefreshConnectionDetails
object
The information about the Refresh Connection external attributes.
1 property 1 required
CreateMaintenanceConfigurationDetails
object
Defines the maintenance configuration for create operation.
5 properties
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
TestPipelineConnectionError
object
The error returned when a pipeline connection fails to connect.
DeploymentPlacementInfo
object
Specifies a deployment placement with explicit availability and fault domain specification.
2 properties 2 required
PipelineDiagnosticData
object
Information regarding the pipeline diagnostic collection
5 properties 4 required
UpdateOggDeploymentDetails
object
Deployment Details for updating an OggDeployment
9 properties
RecipeSummary
object
The list of recipe details to create pipelines.
6 properties 5 required
SourcePipelineConnectionDetails
object
The source connection details for creating a pipeline.
1 property 1 required
CancelDeploymentBackupDetails
object
The information about the Cancel for a DeploymentBackup.
1 property 1 required
CertificateCollection
object
A list of Certificates.
1 property 1 required
OggDeployment
object
Deployment Data for an OggDeployment
9 properties 2 required
DeploymentPlacementDetails
object
Specifies a possible deployment placement. Placement either explicitly specifies the availability and fault domain, or it is partial and lets Oracle to find an…
2 properties
TrailSequenceCollection
object
A list of TrailSequences.
2 properties 2 required
MigrateConnectionDetails
object
The information about the Migrate Connection.
1 property 1 required
AddResourceLockDetails
object
Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resourc…
2 properties 1 required
TestPipelineConnectionResult
object
Result of the connectivity test performed on a pipeline's assigned connection.
2 properties 1 required
CopyDeploymentBackupDetails
object
The information about the copy for a Deployment Backup.
4 properties 2 required
GenerateLibraryUrlDetails
object
The information about generating the library URL.
1 property 1 required
PausePipelineDetails
object
Details for a pipeline pause.
1 property 1 required
ConnectionAssignmentSummary
object
Summary of the Connection Assignment.
9 properties 9 required
TestPipelineConnectionDetails
object
Details about testing the pipeline's assigned connection.
1 property 1 required
UpdateDeploymentDetails
object
The information to use to update a Deployment.
21 properties
DeploymentWalletsOperationCollection
object
A list of deployment wallets operations.
1 property 1 required
PipelineInitializationSteps
object
The steps and their progress, based on the recipe type.
1 property 1 required
WorkRequest
object
The API operations that create and configure GoldenGate resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow…
9 properties 7 required
PipelineRunningProcessCollection
object
The complete replication process and its details.
1 property 1 required
RescheduleDeploymentUpgradeDetails
object
The information about canceling.
1 property 1 required
MaintenanceWindow
object
Defines the maintenance window, when automatic actions can be performed.
2 properties 2 required
RemoveDeploymentLocalPeerDetails
object
The information about removing a deployment peer.
2 properties 2 required
DeploymentSummary
object
Summary of the Deployment.
37 properties 6 required
UpdateDatabaseRegistrationDetails
object
The information to update a DatabaseRegistration.
11 properties
TestConnectionAssignmentError
object
Error Information.
4 properties 2 required
AddDeploymentLocalPeerDetails
object
The information about adding a deployment peer in list.
2 properties
ChangePipelineCompartmentDetails
object
The new compartment for a Pipeline.
1 property 1 required
TrailSequenceSummary
object
Summary of the TrailSequences.
4 properties 1 required
DeploymentWalletsOperationSummary
object
Summary of the deployment wallets operations.
6 properties 5 required
DeploymentVersionSummary
object
The summary data of a specific deployment version.
6 properties 2 required
ConnectionAssignment
object
Represents the metadata description of a connection assignment. Before you can use a connection as a GoldenGate source or target, you must assign it to a deplo…
9 properties 8 required
DeploymentUpgrade
object
A container for your OCI GoldenGate Upgrade information.
29 properties 4 required
CreateCertificateDetails
object
The information about a new Certificates.
2 properties 2 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
Deployment
object
A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
57 properties 8 required
MessageSummary
object
Deployment message Summary.
3 properties 3 required
DeploymentWalletExistsResponseDetails
object
Indicates whether the wallet exists in the deployment container
1 property 1 required
StepMessage
object
Contents of a step message.
4 properties 4 required
UpdateConnectionDetails
object
The information to update a Connection.
12 properties
DeploymentDiagnosticData
object
Information regarding the deployment diagnostic collection
6 properties 4 required
CertificateSummary
object
Summary of the Certificates.
6 properties 6 required
IngressIpDetails
object
Private Endpoint IP Addresses created in the customer's subnet. GoldenGate service will use these ingress IP addresses to send all specific requests initiated…
1 property 1 required
ConnectionCollection
object
List of connection summary objects.
1 property 1 required
DeploymentTypeSummary
object
The meta-data specific on particular deployment type represented by deploymentType field. Deprecated properties: sourceTechnologies and targetTechnologies are…
11 properties 3 required
PipelineCollection
object
List of pipeline summary objects.
1 property 1 required
DeploymentEnvironmentCollection
object
The list of DeploymentEnvironmentDescriptor objects.
1 property 1 required
UpdateGroupToRolesMappingDetails
object
Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM dep…
4 properties
DeploymentBackupSummary
object
The summary of the Backup.
24 properties 6 required
AiModelAuthType
string
Authentication type used by the AI model connection.
AiModelCollection
object
Collection of AI models currently known by GoldenGate for the specified provider.
1 property 1 required
RecipeSummaryCollection
object
The list of Recipe objects.
1 property 1 required
StartDeploymentDetails
object
The information about the Start for a Deployment.
1 property 1 required
LibraryUrl
object
A Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connect…
1 property 1 required
RollbackDeploymentUpgradeDetails
object
The information about the rollback of an upgrade.
1 property 1 required
CollectDeploymentDiagnosticDetails
object
Details for collecting deployment diagnostic
5 properties 3 required
BackupSchedule
object
Defines the schedule of the deployment backup.
6 properties 6 required
CreateDeploymentDetails
object
The information about a new Deployment.
31 properties 3 required
PipelineSchemaSummary
object
List of source and target schemas of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched source and…
2 properties 2 required
Connection
object
Represents the metadata description of a connection used by deployments in the same compartment.
23 properties 7 required
TestConnectionAssignmentResult
object
The result of the connectivity test performed between the GoldenGate deployment and the associated database / service. The 'error' property is deprecated and w…
3 properties 1 required
CreateBackupScheduleDetails
object
Defines the backup schedule details for create operation.
6 properties 6 required
TargetPipelineConnectionDetails
object
The target connection details for creating a pipeline.
1 property 1 required
GenerateDisasterRecoveryPrecheckReportDetails
object
Metadata required to submit to generate a DR precheck report.
2 properties 2 required
UpgradeDeploymentUpgradeDetails
object
The information about the upgrade for a deployment.
1 property 1 required
AiProviderSummary
object
Summary details of an AI provider and its supported models.
6 properties 5 required
StopDeploymentDetails
object
The information about the Stop for a Deployment.
1 property 1 required
ChangeDeploymentCompartmentDetails
object
The new compartment for a Deployment.
1 property 1 required
AiProviderCollection
object
Collection of AI providers supported by GoldenGate.
1 property 1 required
DatabaseRegistrationCollection
object
A list of DatabaseRegistrations.
1 property 1 required
ConnectionSummary
object
Summary of the Connection.
23 properties 7 required
RestoreDeploymentDetails
object
The information about the Restore for a Deployment.
1 property 1 required
ChangeDatabaseRegistrationCompartmentDetails
object
The new compartment for a DatabaseRegistration.
1 property 1 required
Error
object
Error information.
2 properties 2 required
AiModelSummary
object
Summary details of an AI model supported by a provider.
4 properties 4 required
DeploymentPeerSummary
object
The summary of the deployment Peer.
16 properties 11 required
CancelDeploymentUpgradeDetails
object
The information about canceling.
1 property 1 required
PipelineInitializationStep
object
The step and its progress based on the recipe type.
6 properties 5 required
DeploymentMessageCollection
object
A list of DeploymentMessages.
1 property 1 required
CreatePipelineDetails
object
Details with which to create a pipeline.
13 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Golden Gate API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.