Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• host(required): string
  Veridata Agent Host.
• password(required): string (password)
  Encrypted Database connection password.
• port(required): integer
  Veridata Agent Port.
• ssl: boolean
  Default Value: false

  Use Secure Socket Layer (SSL) for Server-Agent communication.
• username(required): string
  Database Connection Username.

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Veridata Agent Host."
        },
        "port":{
            "type":"integer",
            "description":"Veridata Agent Port."
        },
        "username":{
            "type":"string",
            "description":"Database Connection Username."
        },
        "password":{
            "type":"string",
            "description":"Encrypted Database connection password.",
            "format":"password"
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        }
    },
    "required":[
        "host",
        "port",
        "username",
        "password"
    ],
    "example":{
        "host":"100.101.98.100",
        "port":8089,
        "username":"user1",
        "password":"Welcome@123",
        "ssl":false
    }
}

Example:

{
    "host":"100.101.98.100",
    "port":8089,
    "username":"user1",
    "password":"Welcome@123",
    "ssl":false
}

Back to Top

Response

Supported Media Types

• application/json
• */*

200 Response

Database Connection is successful.

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