Validate Agent Connection
post
http://{host}:{port}/veridata/v1/services/validate/connection
Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Validate Agent Connection.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object- dbType: string Allowed Values:
[ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]Database Type. - host(required): string Agent host.
- port(required): integer Agent port.
- ssl: boolean Default Value:
falseUse Secure Socket Layer (SSL) for Server-Agent communication.
Example:
{ "host":"100.101.98.100", "port":8089, "ssl":false, "dbType":"ORACLE" }Response
Supported Media Types
- application/json
200 Response
Agent Connection is valid.
Root Schema : schema
Type:
Show Source object- dbType: string Allowed Values:
[ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]Database Type. - host(required): string Agent host.
- port(required): integer Agent port.
- ssl: boolean Default Value:
falseUse Secure Socket Layer (SSL) for Server-Agent communication.
Example:
{ "host":"100.101.98.100", "port":8089, "ssl":false, "dbType":"ORACLE" }400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }404 Response
Not Found.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }500 Response
Server Error.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }