REST API for GoldenGate Veridata

Retrieve Agent Connections

get

http://{host}:{port}/veridata/v1/services/configuration/connections

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Returns a list of agent connections.

Request

Query Parameters

dbType:

Database type.
description: string

Connection description.
name: string

The Connection's name.
properties: boolean

When set to true, will fetch connection properties.

Default Value: false
settings: boolean

When set to true, will fetch connection settings.

Default Value: false
ssl: string

SSL enabled Connections.

Default Value: all

Allowed Values: [ "true", "false", "all" ]

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Connections retrieved successfully.

Root Schema : schema

Type: array

Show Source

Array of: object BaseConnection

{ "type":"array", "items":{ "$ref":"#/components/schemas/BaseConnection" } }

Nested Schema : BaseConnection

Type: object

Show Source

createdOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
description: string

Connection Description.
host: string

Veridata Agent Host.
id: integer (int64)

Connection Id.
name: string

Connection Name.
port: integer (int32)

Veridata Agent Port.
updatedOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "name":{ "type":"string", "description":"Connection Name." }, "description":{ "type":"string", "description":"Connection Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" } }, "example":{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 } }

Example:

{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 }

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }