REST API for GoldenGate Veridata

Retrieve Connection

get

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

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

Returns connection details.

Request

Path Parameters

Id(required): integer(int64)

Connection ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successfully returned agent connection.

Root Schema : Connection

Type: object

Show Source

agentId: integer

Specifies the managed Agent id associated with connection.
agentVersions: object AgentVersions
availableTimezones: object availableTimezones

List of timezones.
dbType: string

Allowed Values: [ "NOTSPECIFIED", "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL", "MARIADB", "SINGLESTORE", "DATABRICKS", "SNOWFLAKE", "MONGODB", "JCT", "AJD", "COSMOS", "ATLAS", "docDB" ]

Database Type.
managed: boolean

Specifies whether the connection is associated with managed Agent.
properties: array properties
repairUsername: string

DB user having repair access.
settings: array settings
username: string

Database connection username.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseConnection"
        }
    ],
    "example":{
        "createdOn":"2025-04-02T11:20:51.270Z",
        "description":"Connection to source Oracle Database",
        "host":"100.00.00.00",
        "id":1090,
        "name":"Oracle-Connection-Source",
        "port":7800,
        "availableTimezones":{
            "DEFAULT TIMEZONE":"DEFAULT",
            "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
        },
        "dbType":"oracle",
        "managed":true,
        "agentId":1004,
        "agentVersions":{
            "agentVersion":"23.26.1.0.0",
            "protocolVersion":3
        },
        "properties":[
            {
                "datatype":"ARRAY",
                "datatypeNumber":2004,
                "defaultFormat":{
                    "defaultFormatType":"ggComparisonFormatBlob",
                    "formatName":"blob"
                },
                "searchable":true,
                "useDefault":true
            }
        ],
        "settings":[
            {
                "default":true,
                "defaultValue":true,
                "name":"useSourceTargetAsKeys",
                "type":"BOOLEAN",
                "value":true
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":3600,
                "name":"agentTimeout",
                "type":"INTEGER",
                "value":3600
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":1000,
                "name":"fetchSize",
                "type":"INTEGER",
                "value":1000
            }
        ],
        "updatedOn":"2025-04-02T11:20:51Z",
        "username":"User"
    },
    "properties":{
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "managed":{
            "type":"boolean",
            "nullable":true,
            "description":"Specifies whether the connection is associated with managed Agent."
        },
        "agentId":{
            "type":"integer",
            "nullable":true,
            "description":"Specifies the managed Agent id associated with connection."
        },
        "agentVersions":{
            "type":"object",
            "nullable":true,
            "description":"Specifies the version details for managed Agent associated with connection.",
            "$ref":"#/components/schemas/AgentVersions"
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionProperty"
            }
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RetrieveConnectionSettings"
            }
        },
        "availableTimezones":{
            "type":"object",
            "description":"List of timezones."
        }
    }
}

Match All

Show Source

object BaseConnection

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseConnection"
        }
    ],
    "example":{
        "createdOn":"2025-04-02T11:20:51.270Z",
        "description":"Connection to source Oracle Database",
        "host":"100.00.00.00",
        "id":1090,
        "name":"Oracle-Connection-Source",
        "port":7800,
        "availableTimezones":{
            "DEFAULT TIMEZONE":"DEFAULT",
            "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
        },
        "dbType":"oracle",
        "managed":true,
        "agentId":1004,
        "agentVersions":{
            "agentVersion":"23.26.1.0.0",
            "protocolVersion":3
        },
        "properties":[
            {
                "datatype":"ARRAY",
                "datatypeNumber":2004,
                "defaultFormat":{
                    "defaultFormatType":"ggComparisonFormatBlob",
                    "formatName":"blob"
                },
                "searchable":true,
                "useDefault":true
            }
        ],
        "settings":[
            {
                "default":true,
                "defaultValue":true,
                "name":"useSourceTargetAsKeys",
                "type":"BOOLEAN",
                "value":true
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":3600,
                "name":"agentTimeout",
                "type":"INTEGER",
                "value":3600
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":1000,
                "name":"fetchSize",
                "type":"INTEGER",
                "value":1000
            }
        ],
        "updatedOn":"2025-04-02T11:20:51Z",
        "username":"User"
    },
    "properties":{
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "managed":{
            "type":"boolean",
            "nullable":true,
            "description":"Specifies whether the connection is associated with managed Agent."
        },
        "agentId":{
            "type":"integer",
            "nullable":true,
            "description":"Specifies the managed Agent id associated with connection."
        },
        "agentVersions":{
            "type":"object",
            "nullable":true,
            "description":"Specifies the version details for managed Agent associated with connection.",
            "$ref":"#/components/schemas/AgentVersions"
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionProperty"
            }
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RetrieveConnectionSettings"
            }
        },
        "availableTimezones":{
            "type":"object",
            "description":"List of timezones."
        }
    }
}

Example:

{
    "createdOn":"2025-04-02T11:20:51.270Z",
    "description":"Connection to source Oracle Database",
    "host":"100.00.00.00",
    "id":1090,
    "name":"Oracle-Connection-Source",
    "port":7800,
    "availableTimezones":{
        "DEFAULT TIMEZONE":"DEFAULT",
        "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
    },
    "dbType":"oracle",
    "managed":true,
    "agentId":1004,
    "agentVersions":{
        "agentVersion":"23.26.1.0.0",
        "protocolVersion":3
    },
    "properties":[
        {
            "datatype":"ARRAY",
            "datatypeNumber":2004,
            "defaultFormat":{
                "defaultFormatType":"ggComparisonFormatBlob",
                "formatName":"blob"
            },
            "searchable":true,
            "useDefault":true
        }
    ],
    "settings":[
        {
            "default":true,
            "defaultValue":true,
            "name":"useSourceTargetAsKeys",
            "type":"BOOLEAN",
            "value":true
        },
        {
            "default":true,
            "min":0,
            "max":100000,
            "defaultValue":3600,
            "name":"agentTimeout",
            "type":"INTEGER",
            "value":3600
        },
        {
            "default":true,
            "min":0,
            "max":100000,
            "defaultValue":1000,
            "name":"fetchSize",
            "type":"INTEGER",
            "value":1000
        }
    ],
    "updatedOn":"2025-04-02T11:20:51Z",
    "username":"User"
}

Nested Schema : AgentVersions

Type: object

Show Source

protocolVersion: string
version: string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "protocolVersion":{
            "type":"string"
        }
    },
    "example":{
        "agentVersion":"23.26.1.0.0",
        "protocolVersion":"3"
    }
}

Example:

{
    "agentVersion":"23.26.1.0.0",
    "protocolVersion":"3"
}

Nested Schema : availableTimezones

Type: object

List of timezones.

Nested Schema : properties

Type: array

Show Source

Array of: object ConnectionProperty

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

Nested Schema : settings

Type: array

Show Source

Array of: object RetrieveConnectionSettings

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

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
}

Nested Schema : ConnectionProperty

Type: object

Show Source

compareFormat: string

Allowed Values: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

Compare Format.
dataType: string
isDefault: boolean

Default Value: true

Defines if default property is used or not.
precision: integer (int32)
scale: integer (int32)
timezone: string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "compareFormat":{
            "$ref":"#/components/schemas/CompareFormat"
        },
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "scale":{
            "type":"integer",
            "format":"int32"
        },
        "timezone":{
            "type":"string"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Defines if default property is used or not.",
            "default":true
        }
    }
}

Nested Schema : RetrieveConnectionSettings

Type: object

Show Source

default: boolean
defaultValue: object defaultValue
max: integer
min: integer
name: string
type: string

Allowed Values: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
value: object value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "default":{
            "type":"boolean"
        },
        "defaultValue":{
            "type":"object"
        },
        "value":{
            "type":"object"
        },
        "type":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "ENUM",
                "INTEGER",
                "STRING"
            ]
        },
        "min":{
            "type":"integer"
        },
        "max":{
            "type":"integer"
        }
    },
    "example":[
        {
            "default":true,
            "defaultValue":true,
            "name":"useSourceTargetAsKeys",
            "type":"BOOLEAN",
            "value":"true"
        },
        {
            "default":true,
            "defaultValue":true,
            "name":"useAllColsAsKeys",
            "type":"BOOLEAN",
            "value":"true"
        },
        {
            "default":true,
            "defaultValue":1000,
            "name":"fetchSize",
            "type":"INTEGER",
            "value":"1000"
        },
        {
            "default":true,
            "min":0,
            "max":10000000,
            "defaultValue":3600,
            "name":"agentTimeout",
            "type":"INTEGER",
            "value":"3600"
        }
    ]
}

Example:

[
    {
        "default":true,
        "defaultValue":true,
        "name":"useSourceTargetAsKeys",
        "type":"BOOLEAN",
        "value":"true"
    },
    {
        "default":true,
        "defaultValue":true,
        "name":"useAllColsAsKeys",
        "type":"BOOLEAN",
        "value":"true"
    },
    {
        "default":true,
        "defaultValue":1000,
        "name":"fetchSize",
        "type":"INTEGER",
        "value":"1000"
    },
    {
        "default":true,
        "min":0,
        "max":10000000,
        "defaultValue":3600,
        "name":"agentTimeout",
        "type":"INTEGER",
        "value":"3600"
    }
]

Nested Schema : defaultValue

Type: object

Nested Schema : value

Type: object

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"
}