Send Requests
Review the following information before sending requests using the GoldenGate Veridata 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 /veridata/v1
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 Veridata metadata, statistics. |
POST | Create, run or stop the stop the Veridata service. |
PUT | Update the veridata metadata. |
PATCH | Patch the Veridata metadata. |
DELETE | Delete the Veridata metadata, statistics. |
Media Types
The following media types are supported by the GoldenGate Stream Analytics REST API:
-
application/json
Supported Headers
The GoldenGate Veridata 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 |
Authorization | Token for the particular session | authorization: Bearer <Token value> |