Validate Agent Database
post
http://{host}:{port}/veridata/v1/services/validate/connection/db
Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Validates Agent database connection.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object- host(required): string Veridata Agent Host.
- password(required): string (password) Encrypted Database connection password.
- port(required): integer Veridata Agent Port.
- ssl: boolean Default Value:
falseUse Secure Socket Layer (SSL) for Server-Agent communication. - username(required): string Database Connection Username.
Example:
{ "host":"100.101.98.100", "port":8089, "username":"user1", "password":"Welcome@123", "ssl":false }Response
Supported Media Types
- application/json
- */*
200 Response
Database Connection is successful.
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" }