Oracle GoldenGate Certificates API

Manage SSL certificates for deployments

Operations 5

GET /20200407/deployments/{deploymentId}/certificates Oracle Goldengate List Deployment Certificates #
POST /20200407/deployments/{deploymentId}/certificates Oracle Goldengate Add a Certificate to a Deployment #
GET /services/v2/certificates Oracle Goldengate Retrieve Available Certificate Types #
GET /services/v2/certificates/{type} Oracle Goldengate Retrieve Certificate Names #
GET /services/v2/certificates/{type}/{certificate} Oracle Goldengate Retrieve a Certificate #

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

Other Resources

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-certificates-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.

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

OpenAPI Specification

oracle-goldengate-certificates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Goldengate Certificates API
  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
  version: '1.0'
  description: 'Operations tagged Certificates across 2 of this provider''s published API definitions: oracle-goldengate-cloud-service-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.{region}.oci.oraclecloud.com
  description: OCI GoldenGate regional endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
      enum:
      - us-ashburn-1
      - us-phoenix-1
      - eu-frankfurt-1
      - uk-london-1
      - ap-tokyo-1
      - ap-sydney-1
      - ca-toronto-1
      - ap-mumbai-1
      - sa-saopaulo-1
- 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
tags:
- name: Certificates
  description: Manage SSL certificates for deployments
paths:
  /20200407/deployments/{deploymentId}/certificates:
    get:
      operationId: listCertificates
      summary: Oracle Goldengate List Deployment Certificates
      description: Returns SSL certificates associated with a deployment.
      tags:
      - Certificates
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Certificates listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateCollection'
              examples:
                Listcertificates200Example:
                  summary: Default listCertificates 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - key: example_value
                      subject: example_value
                      lifecycleState: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    post:
      operationId: createCertificate
      summary: Oracle Goldengate Add a Certificate to a Deployment
      description: Adds a trusted SSL certificate to a GoldenGate deployment.
      tags:
      - Certificates
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCertificateDetails'
            examples:
              CreatecertificateRequestExample:
                summary: Default createCertificate request
                x-microcks-default: true
                value:
                  key: example_value
                  certificateContent: example_value
      responses:
        '200':
          description: Certificate added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                Createcertificate200Example:
                  summary: Default createCertificate 200 response
                  x-microcks-default: true
                  value:
                    key: example_value
                    deploymentId: '500123'
                    subject: example_value
                    issuer: example_value
                    isSelfSigned: true
                    md5Hash: example_value
                    publicKey: example_value
                    publicKeyAlgorithm: example_value
                    timeValidFrom: '2026-01-15T10:30:00Z'
                    timeValidTo: '2026-01-15T10:30:00Z'
                    serial: example_value
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    servers:
    - url: https://goldengate.{region}.oci.oraclecloud.com
      description: OCI GoldenGate regional endpoint
      variables:
        region:
          default: us-ashburn-1
          description: OCI region identifier
          enum:
          - us-ashburn-1
          - us-phoenix-1
          - eu-frankfurt-1
          - uk-london-1
          - ap-tokyo-1
          - ap-sydney-1
          - ca-toronto-1
          - ap-mumbai-1
          - sa-saopaulo-1
  /services/v2/certificates:
    get:
      operationId: listCertificateTypes
      summary: Oracle Goldengate Retrieve Available Certificate Types
      description: Returns the list of available certificate types (trusted, server, client).
      tags:
      - Certificates
      responses:
        '200':
          description: Certificate types listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateTypeList'
              examples:
                Listcertificatetypes200Example:
                  summary: Default listCertificateTypes 200 response
                  x-microcks-default: true
                  value:
                    types:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    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/certificates/{type}:
    get:
      operationId: listCertificates
      summary: Oracle Goldengate Retrieve Certificate Names
      description: Returns a list of certificate names for a specific type.
      tags:
      - Certificates
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
          enum:
          - trusted
          - server
          - client
        example: trusted
      responses:
        '200':
          description: Certificates listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateNameList'
              examples:
                Listcertificates200Example:
                  summary: Default listCertificates 200 response
                  x-microcks-default: true
                  value:
                    certificates:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    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/certificates/{type}/{certificate}:
    get:
      operationId: getCertificate
      summary: Oracle Goldengate Retrieve a Certificate
      description: Returns the details of a specific certificate.
      tags:
      - Certificates
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
        example: example_value
      - name: certificate
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Certificate retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate_2'
              examples:
                Getcertificate200Example:
                  summary: Default getCertificate 200 response
                  x-microcks-default: true
                  value:
                    alias: example_value
                    subject: example_value
                    issuer: example_value
                    serialNumber: example_value
                    notBefore: '2026-01-15T10:30:00Z'
                    notAfter: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    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:
  schemas:
    CreateCertificateDetails:
      type: object
      required:
      - key
      - certificateContent
      properties:
        key:
          type: string
          example: example_value
        certificateContent:
          type: string
          example: example_value
    Certificate:
      type: object
      properties:
        key:
          type: string
          example: example_value
        deploymentId:
          type: string
          example: '500123'
        subject:
          type: string
          example: example_value
        issuer:
          type: string
          example: example_value
        isSelfSigned:
          type: boolean
          example: true
        md5Hash:
          type: string
          example: example_value
        publicKey:
          type: string
          example: example_value
        publicKeyAlgorithm:
          type: string
          example: example_value
        timeValidFrom:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        timeValidTo:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        serial:
          type: string
          example: example_value
        lifecycleState:
          type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    CertificateSummary:
      type: object
      properties:
        key:
          type: string
          example: example_value
        subject:
          type: string
          example: example_value
        lifecycleState:
          type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    CertificateCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CertificateSummary'
          example: []
    Certificate_2:
      type: object
      properties:
        alias:
          type: string
          example: example_value
        subject:
          type: string
          example: example_value
        issuer:
          type: string
          example: example_value
        serialNumber:
          type: string
          example: example_value
        notBefore:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        notAfter:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    CertificateTypeList:
      type: object
      properties:
        types:
          type: array
          items:
            type: string
          example: []
    ErrorResponse:
      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
    CertificateNameList:
      type: object
      properties:
        certificates:
          type: array
          items:
            type: string
          example: []
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 10
    pageParam:
      name: page
      in: query
      description: Pagination token
      schema:
        type: string
    deploymentIdParam:
      name: deploymentId
      in: path
      required: true
      description: The OCID of the deployment
      schema:
        type: string
  responses:
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI API request signature (RFC 7616) or bearer token authentication
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with GoldenGate user credentials
x-refined-from:
- oracle-goldengate-cloud-service-api-openapi.yml
- oracle-goldengate-rest-api-openapi.yml