Oracle GoldenGate Pipelines API

openapi: 3.1.0
info:
  title: Oracle GoldenGate for Big Data REST Artifacts Pipelines API
  description: REST API for managing Oracle GoldenGate for Big Data deployments via the Microservices Architecture. Enables configuration and monitoring of replication to big data targets including Apache Kafka, HDFS, HBase, Cassandra, MongoDB, Elasticsearch, and cloud object stores. Uses the same Microservices Architecture REST API base as the core GoldenGate product with big data-specific replicat handlers and data target types.
  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-documentation:
  - url: https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/index.html
    description: Oracle GoldenGate for Big Data Administration Guide
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: Pipelines
  description: Manage data replication pipelines
paths:
  /20200407/pipelines:
    get:
      operationId: listPipelines
      summary: Oracle Goldengate List Pipelines
      description: Returns a list of data replication pipelines.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Pipelines listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineCollection'
              examples:
                Listpipelines200Example:
                  summary: Default listPipelines 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      displayName: example_value
                      lifecycleState: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createPipeline
      summary: Oracle Goldengate Create a Pipeline
      description: Creates a new data replication pipeline.
      tags:
      - Pipelines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePipelineDetails'
            examples:
              CreatepipelineRequestExample:
                summary: Default createPipeline request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  compartmentId: '500123'
                  sourceConnectionDetailId: '500123'
                  targetConnectionDetailId: '500123'
      responses:
        '200':
          description: Pipeline creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
              examples:
                Createpipeline200Example:
                  summary: Default createPipeline 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    sourceConnectionDetailId: '500123'
                    targetConnectionDetailId: '500123'
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/pipelines/{pipelineId}:
    get:
      operationId: getPipeline
      summary: Oracle Goldengate Get a Pipeline
      description: Returns the details of a specific pipeline.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam'
      responses:
        '200':
          description: Pipeline retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
              examples:
                Getpipeline200Example:
                  summary: Default getPipeline 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    sourceConnectionDetailId: '500123'
                    targetConnectionDetailId: '500123'
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updatePipeline
      summary: Oracle Goldengate Update a Pipeline
      description: Updates a pipeline configuration.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePipelineDetails'
            examples:
              UpdatepipelineRequestExample:
                summary: Default updatePipeline request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
      responses:
        '200':
          description: Update initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deletePipeline
      summary: Oracle Goldengate Delete a Pipeline
      description: Deletes a data replication pipeline.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      responses:
        '202':
          description: Deletion accepted
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/pipelines/{pipelineId}/actions/start:
    post:
      operationId: startPipeline
      summary: Oracle Goldengate Start a Pipeline
      description: Starts a stopped pipeline.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      responses:
        '202':
          description: Start initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/pipelines/{pipelineId}/actions/stop:
    post:
      operationId: stopPipeline
      summary: Oracle Goldengate Stop a Pipeline
      description: Stops a running pipeline.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      responses:
        '202':
          description: Stop initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v1/pipelines:
    get:
      operationId: listPipelines
      summary: Oracle Goldengate List Pipelines
      description: Returns a list of all GGSA pipelines with their current status. Includes published and unpublished pipelines.
      tags:
      - Pipelines
      responses:
        '200':
          description: Pipelines listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineList'
              examples:
                Listpipelines200Example:
                  summary: Default listPipelines 200 response
                  x-microcks-default: true
                  value:
                    pipelines:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      status: Draft
                      createdBy: example_value
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
                      sources: {}
                      targets: {}
                      stages: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v1/pipelines/{id}/export:
    get:
      operationId: exportPipeline
      summary: Oracle Goldengate Export a Pipeline
      description: Exports a GGSA pipeline and all its dependencies as a JSON artifact, including sources, targets, references, connections, predictive models, geo fences, visualizations, and custom jars.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam_2'
      responses:
        '200':
          description: Pipeline exported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineExport'
              examples:
                Exportpipeline200Example:
                  summary: Default exportPipeline 200 response
                  x-microcks-default: true
                  value:
                    pipeline:
                      id: abc123
                      name: Example Title
                      description: A sample description.
                      status: Draft
                      createdBy: example_value
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
                      sources:
                      - {}
                      targets:
                      - {}
                      stages:
                      - {}
                    connections:
                    - name: Example Title
                      type: example_value
                      configuration: example_value
                    references:
                    - name: Example Title
                      type: example_value
                    customJars:
                    - name: Example Title
                      path: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v1/pipelines/{id}/publish:
    patch:
      operationId: publishPipeline
      summary: Oracle Goldengate Publish a Pipeline
      description: Publishes a pipeline, deploying it to the Spark runtime for execution. A published pipeline actively processes streaming data from configured sources and writes results to configured targets.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishPipelineRequest'
            examples:
              PublishpipelineRequestExample:
                summary: Default publishPipeline request
                x-microcks-default: true
                value:
                  sparkConfig: example_value
      responses:
        '200':
          description: Pipeline published
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline_2'
              examples:
                Publishpipeline200Example:
                  summary: Default publishPipeline 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    status: Draft
                    createdBy: example_value
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
                    sources:
                    - id: abc123
                      name: Example Title
                      type: Kafka
                      connectionName: example_value
                    targets:
                    - id: abc123
                      name: Example Title
                      type: Kafka
                      connectionName: example_value
                    stages:
                    - id: abc123
                      name: Example Title
                      type: Query
                      description: A sample description.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v1/pipelines/{id}/unpublish:
    patch:
      operationId: unpublishPipeline
      summary: Oracle Goldengate Unpublish a Pipeline
      description: Unpublishes a pipeline, stopping its execution on the Spark runtime. The pipeline configuration is preserved and can be re-published later.
      tags:
      - Pipelines
      parameters:
      - $ref: '#/components/parameters/pipelineIdParam_2'
      responses:
        '200':
          description: Pipeline unpublished
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline_2'
              examples:
                Unpublishpipeline200Example:
                  summary: Default unpublishPipeline 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    status: Draft
                    createdBy: example_value
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
                    sources:
                    - id: abc123
                      name: Example Title
                      type: Kafka
                      connectionName: example_value
                    targets:
                    - id: abc123
                      name: Example Title
                      type: Kafka
                      connectionName: example_value
                    stages:
                    - id: abc123
                      name: Example Title
                      type: Query
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound_2:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
    PipelineList:
      type: object
      properties:
        pipelines:
          type: array
          items:
            $ref: '#/components/schemas/Pipeline_2'
          example: []
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    Pipeline:
      type: object
      properties:
        id:
          type: string
          example: abc123
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        sourceConnectionDetailId:
          type: string
          example: '500123'
        targetConnectionDetailId:
          type: string
          example: '500123'
        lifecycleState:
          type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        timeUpdated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    PipelineExport:
      type: object
      description: Complete pipeline export including all dependencies (sources, targets, connections, references, predictive models, geo fences, visualizations, and custom jars)
      properties:
        pipeline:
          $ref: '#/components/schemas/Pipeline_2'
        connections:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              configuration:
                type: object
                additionalProperties: true
          example: []
        references:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
          example: []
        customJars:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              path:
                type: string
          example: []
    Pipeline_2:
      type: object
      properties:
        id:
          type: string
          description: Pipeline unique identifier
          example: abc123
        name:
          type: string
          description: Pipeline display name
          example: Example Title
        description:
          type: string
          example: A sample description.
        status:
          type: string
          description: Current pipeline status
          enum:
          - Draft
          - Published
          - Running
          - Stopped
          - Error
          example: Draft
        createdBy:
          type: string
          example: example_value
        createdAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        sources:
          type: array
          items:
            $ref: '#/components/schemas/PipelineSource'
          example: []
        targets:
          type: array
          items:
            $ref: '#/components/schemas/PipelineTarget'
          example: []
        stages:
          type: array
          items:
            $ref: '#/components/schemas/PipelineStage'
          example: []
    PipelineSource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        type:
          type: string
          description: Source type
          enum:
          - Kafka
          - GoldenGate
          - JMS
          - REST
          - CSV
          - Database
          example: Kafka
        connectionName:
          type: string
          example: example_value
    CreatePipelineDetails:
      type: object
      required:
      - displayName
      - compartmentId
      properties:
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        sourceConnectionDetailId:
          type: string
          example: '500123'
        targetConnectionDetailId:
          type: string
          example: '500123'
    PipelineSummary:
      type: object
      properties:
        id:
          type: string
          example: abc123
        displayName:
          type: string
          example: example_value
        lifecycleState:
          type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    PublishPipelineRequest:
      type: object
      properties:
        sparkConfig:
          type: object
          description: Optional Spark configuration overrides
          additionalProperties:
            type: string
          example: example_value
    PipelineTarget:
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        type:
          type: string
          description: Target type
          enum:
          - Kafka
          - GoldenGate
          - Database
          - REST
          - Elasticsearch
          - ObjectStorage
          example: Kafka
        connectionName:
          type: string
          example: example_value
    PipelineStage:
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        type:
          type: string
          enum:
          - Query
          - Pattern
          - Rule
          - ScoreModel
          - Custom
          example: Query
        description:
          type: string
          example: A sample description.
    PipelineCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PipelineSummary'
          example: []
    UpdatePipelineDetails:
      type: object
      properties:
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
  parameters:
    ifMatchParam:
      name: if-match
      in: header
      description: ETag for optimistic concurrency control
      schema:
        type: string
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 10
    pipelineIdParam:
      name: pipelineId
      in: path
      required: true
      description: The OCID of the pipeline
      schema:
        type: string
    pageParam:
      name: page
      in: query
      description: Pagination token
      schema:
        type: string
    compartmentIdParam:
      name: compartmentId
      in: query
      required: true
      description: The OCID of the compartment
      schema:
        type: string
    pipelineIdParam_2:
      name: id
      in: path
      required: true
      description: Pipeline identifier
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic