Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dbType: string
  Allowed Values: [ "notspecified", "oracle", "tandemnsk", "sqlserver", "sybase", "db2", "teradata", "informix", "hive", "mysql", "postgresql", "mariadb", "singlestore", "databricks", "snowflake", "mongodb", "jct", "ajd", "cosmos", "atlas", "docdb" ]

  Database Type.
• host(required): string
  Agent host.
• port(required): integer
  Agent port.
• ssl: boolean
  Default Value: false

  Use Secure Socket Layer (SSL) for Server-Agent communication.

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Agent host."
        },
        "port":{
            "type":"integer",
            "description":"Agent port."
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        }
    },
    "required":[
        "host",
        "port"
    ],
    "example":{
        "host":"100.101.98.100",
        "port":8089,
        "ssl":false,
        "dbType":"ORACLE"
    }
}

Example:

{
    "host":"100.101.98.100",
    "port":8089,
    "ssl":false,
    "dbType":"ORACLE"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Agent Connection is valid.

Body ()

Root Schema : schema

Type: object

Show Source

• dbType: string
  Allowed Values: [ "notspecified", "oracle", "tandemnsk", "sqlserver", "sybase", "db2", "teradata", "informix", "hive", "mysql", "postgresql", "mariadb", "singlestore", "databricks", "snowflake", "mongodb", "jct", "ajd", "cosmos", "atlas", "docdb" ]

  Database Type.
• host(required): string
  Agent host.
• port(required): integer
  Agent port.
• ssl: boolean
  Default Value: false

  Use Secure Socket Layer (SSL) for Server-Agent communication.

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Agent host."
        },
        "port":{
            "type":"integer",
            "description":"Agent port."
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        }
    },
    "required":[
        "host",
        "port"
    ],
    "example":{
        "host":"100.101.98.100",
        "port":8089,
        "ssl":false,
        "dbType":"ORACLE"
    }
}

Example:

{
    "host":"100.101.98.100",
    "port":8089,
    "ssl":false,
    "dbType":"ORACLE"
}

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