Oracle GoldenGate

Oracle GoldenGate Credentials API

Manage credential store for big data target connections

GitHub OpenAPI

Operations 7

GET /services/v2/credentials Oracle Goldengate List Credential Domains #
GET /services/v2/credentials/{domain}/{alias} Oracle Goldengate Retrieve a Credential Alias #
POST /services/v2/credentials/{domain}/{alias} Oracle Goldengate Create a Credential Alias #
PUT /services/v2/credentials/{domain}/{alias} Oracle Goldengate Replace a Credential Alias #
DELETE /services/v2/credentials/{domain}/{alias} Oracle Goldengate Delete a Credential Alias #
GET /services/v2/credentials/{domain} Oracle Goldengate List Aliases in a Credential Domain #
GET /services/v2/credentials/{domain}/{alias}/valid Oracle Goldengate Validate a Credential Alias #

Documentation

📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/authentication.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/database/goldengate/core/26/oggra/authenticate.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/core/26/
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/index.html
📖
GettingStarted
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/getting-started.html
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdug/index.html
📖
APIReference
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdra/index.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/veridata/26/
📖
Documentation
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/latest/
📖
GettingStarted
https://docs.oracle.com/en/cloud/paas/goldengate-service/index.html
📖
Authentication
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm
📖
APIReference
https://docs.oracle.com/en-us/iaas/goldengate/doc/using-rest-api.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
APIReference
https://docs.oracle.com/en/middleware/fusion-middleware/osa/19.1/ggsa-rest-api/quick-start.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/coredoc/distribute-datastream-rest-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-credentials-api-openapi.yml

Other Resources

🔗
Tutorials
https://docs.oracle.com/en/database/goldengate/core/26/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/core/26/release-notes/
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/veridata/26/gvdrn/index.html
🔗
SDKs
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdks.htm
🔗
CLI
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm
🔗
Tutorials
https://docs.oracle.com/en/cloud/paas/goldengate-service/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en-us/iaas/releasenotes/services/goldengate/
🔗
SDKs
https://docs.oracle.com/en-us/iaas/tools/python/latest/api/golden_gate.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/release-notes/release-notes-goldengate-stream-analytics.pdf

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-goldengate-credentials-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-goldengate-credentials-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle Goldengate Credentials API
  version: 21.3.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-refined-note:
  - x-documentation differs across the merged source definitions and was not carried
  description: 'Operations tagged Credentials across 2 of this provider''s published API definitions: oracle-goldengate-big-data-rest-api-openapi.yml, oracle-goldengate-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{goldengate-host}:{port}
  description: Oracle GoldenGate for Big Data Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Big Data host
    port:
      default: '443'
      description: HTTPS port
security:
- basicAuth: []
tags:
- name: Credentials
  description: Manage credential store for big data target connections
paths:
  /services/v2/credentials:
    get:
      operationId: listCredentialDomains
      summary: Oracle Goldengate List Credential Domains
      description: Returns all credential store domains used for big data target authentication.
      tags:
      - Credentials
      responses:
        '200':
          description: Domains listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialDomainList'
              examples:
                Listcredentialdomains200Example:
                  summary: Default listCredentialDomains 200 response
                  x-microcks-default: true
                  value:
                    domains:
                    - name: Example Title
                      aliasCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/credentials/{domain}/{alias}:
    get:
      operationId: getCredentialAlias
      summary: Oracle Goldengate Retrieve a Credential Alias
      description: Returns a credential alias used for target system authentication.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '200':
          description: Alias retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Getcredentialalias200Example:
                  summary: Default getCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCredentialAlias
      summary: Oracle Goldengate Create a Credential Alias
      description: Creates a credential alias for authenticating with big data targets.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
            examples:
              CreatecredentialaliasRequestExample:
                summary: Default createCredentialAlias request
                x-microcks-default: true
                value:
                  userid: '500123'
                  password: example_value
      responses:
        '201':
          description: Alias created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Createcredentialalias201Example:
                  summary: Default createCredentialAlias 201 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: replaceCredentialAlias
      summary: Oracle Goldengate Replace a Credential Alias
      description: Replaces an existing credential alias.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
            examples:
              ReplacecredentialaliasRequestExample:
                summary: Default replaceCredentialAlias request
                x-microcks-default: true
                value:
                  userid: '500123'
                  password: example_value
      responses:
        '200':
          description: Alias replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Replacecredentialalias200Example:
                  summary: Default replaceCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCredentialAlias
      summary: Oracle Goldengate Delete a Credential Alias
      description: Deletes a credential alias.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '204':
          description: Alias deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/credentials/{domain}:
    get:
      operationId: listDomainAliases
      summary: Oracle Goldengate List Aliases in a Credential Domain
      description: Returns all credential aliases within a specified domain.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam_2'
      responses:
        '200':
          description: Aliases listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAliasList'
              examples:
                Listdomainaliases200Example:
                  summary: Default listDomainAliases 200 response
                  x-microcks-default: true
                  value:
                    aliases:
                    - domain: example_value
                      alias: example_value
                      userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/credentials/{domain}/{alias}/valid:
    get:
      operationId: validateCredentialAlias
      summary: Oracle Goldengate Validate a Credential Alias
      description: Validates that a credential alias can successfully connect to its target.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam_2'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '200':
          description: Validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
              examples:
                Validatecredentialalias200Example:
                  summary: Default validateCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    valid: '500123'
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
components:
  parameters:
    aliasParam:
      name: alias
      in: path
      required: true
      description: Credential alias name
      schema:
        type: string
    domainParam:
      name: domain
      in: path
      required: true
      description: Credential store domain
      schema:
        type: string
    domainParam_2:
      name: domain
      in: path
      required: true
      description: Credential store domain name
      schema:
        type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound_2:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    Unauthorized_2:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    BadRequest_2:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
  schemas:
    CredentialDomainList:
      type: object
      properties:
        domains:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              aliasCount:
                type: integer
          example: []
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
        severity:
          type: string
          example: example_value
    CredentialAlias:
      type: object
      properties:
        domain:
          type: string
          example: example_value
        alias:
          type: string
          example: example_value
        userid:
          type: string
          example: '500123'
    CreateCredentialRequest:
      type: object
      required:
      - userid
      - password
      properties:
        userid:
          type: string
          example: '500123'
        password:
          type: string
          format: password
          example: example_value
    CredentialAliasList:
      type: object
      properties:
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/CredentialAlias'
          example: []
    CreateCredentialAliasRequest:
      type: object
      required:
      - userid
      - password
      properties:
        userid:
          type: string
          description: Database user ID including connect string
          example: '500123'
        password:
          type: string
          description: Password for the user
          format: password
          example: example_value
    ErrorResponse_2:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          description: Error message
          example: example_value
        severity:
          type: string
          description: Error severity level
          example: example_value
    ValidationResult:
      type: object
      properties:
        valid:
          type: boolean
          example: '500123'
        message:
          type: string
          example: example_value
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- oracle-goldengate-big-data-rest-api-openapi.yml
- oracle-goldengate-rest-api-openapi.yml