1. REST API for GoldenGate Stream AnalyticsREST API for GoldenGate Stream Analytics
  2. Send Requests

Send Requests

Review the following information before sending requests using the GoldenGate Stream Analytics REST API.

URL Structure

Here's the URL structure for the requests:

https://<subdomain>.<domain>.com:<port>/<context-path>/<resource-path>
Where:

  • context-path is /osa/admin for User Management APIs

  • context-path is /osa for Pipeline Management APIs

Supported Methods

Perform basic CRUD operations (create, read, update, and delete) on your GoldenGate Stream Analytics service using standard HTTP request methods.

Note:

You can combine multiple operations into a single HTTP request to improve performance.
HTTP Method Description
GET Retrieve information about the service instance.
HEAD Retrieve header information about the service instance.
POST Create, scale, backup, start, or stop the service instance.
PUT Update the service instance.
PATCH Patch the service instance.
OPTIONS Retrieve information about the options and requirements for the service instance.
DELETE Delete the service instance.

Media Types

The following media types are supported by the GoldenGate Stream Analytics REST API:

  • application/json

Supported Headers

The GoldenGate Stream Analytics REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Accept Media type of the body of the response. Accept application/json
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json