1. REST API for GoldenGate Veridata
  2. Tasks
  3. Configure
  4. Connections

Update Connection

patch

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

Required Role: Administrator, SuperUser, CommandLineOperator

Update connection.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Example:
{
    "description":"Updated description",
    "host":"100.00.00.01",
    "port":7851,
    "ssl":false,
    "username":"User1",
    "password":"Abc@1234",
    "repairUsername":"User1",
    "repairPassword":"Abc@1234",
    "properties":[
        {
            "datatype":"string",
            "compareFormat":{
                "formatName":"blob",
                "precision":0,
                "scale":0,
                "timezone":"string"
            }
        }
    ],
    "settings":{
        "agentTimeout":3000,
        "trimTrailingSpaces":true,
        "fetchSize":5000,
        "ssl":false,
        "useSourceTargetAsKeys":true,
        "useAllColsAsKeys":true
    }
}
Nested Schema : properties
Type: array
Show Source
Nested Schema : ConnectionSettings
Type: object
Show Source
Nested Schema : UpdateConnectionProperty
Type: object
Show Source
Nested Schema : UpdateCompareFormat
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Connection Updated.
Body ()
Root Schema : Connection
Type: object
Show Source
Match All
Show Source
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
Example:
{
    "agentVersion":"23.26.1.0.0",
    "protocolVersion":"3"
}
Nested Schema : availableTimezones
Type: object
List of timezones.
Nested Schema : properties
Type: array
Show Source
Nested Schema : settings
Type: array
Show Source
Nested Schema : BaseConnection
Type: object
Show Source
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
Nested Schema : RetrieveConnectionSettings
Type: object
Show Source
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.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}
Back to Top