Jump to

• Request
• Response

Create Agent Connection

post

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

Required Role: Administrator, SuperUser, CommandLineOperator

Create Agent Connection.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dbType(required): string
  Allowed Values: [ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]

  Database Type.
• description: string
  Connection Description.
• host(required): string
  Veridata Agent Host.
• name(required): string
  Connection Name.
• password(required): string (password)
  Encrypted Database connection password.
• port(required): integer (int32)
  Veridata Agent Port.
• repairPassword: string (password)
  Encrypted DB password having repair access.
• repairUsername: string
  DB user having repair access.
• ssl: boolean
  Default Value: false

  SSL enabled Agent connection to the Server.
• username(required): string
  Database connection username.

{
    "type":"object",
    "properties":{
        "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"
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "ssl":{
            "type":"boolean",
            "description":"SSL enabled Agent connection to the Server.",
            "default":false
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "password":{
            "type":"string",
            "description":"Encrypted Database connection password.",
            "format":"password"
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "repairPassword":{
            "type":"string",
            "description":"Encrypted DB password having repair access.",
            "format":"password"
        }
    },
    "example":{
        "name":"Oracle-Connection-Source",
        "description":"Connection to source Oracle database",
        "host":"100.00.00.00",
        "port":"7850",
        "dbType":"ORACLE",
        "ssl":"false",
        "username":"User",
        "password":"Abc@123"
    },
    "required":[
        "name",
        "host",
        "port",
        "dbType",
        "username",
        "password"
    ]
}

Example:

{
    "name":"Oracle-Connection-Source",
    "description":"Connection to source Oracle database",
    "host":"100.00.00.00",
    "port":"7850",
    "dbType":"ORACLE",
    "ssl":"false",
    "username":"User",
    "password":"Abc@123"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Agent connection created successfully.

Body ()

Root 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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top