connections

Test connection parameters

Test database connection parameters without creating an asset

post/api/v1/assets/test-connection-parameters

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/assets/test-connection-parameters
  • Auth: none declared

Headers

Authorizationstring

Request body

namestring required
descriptionstring nullable
asset_typestring required
hoststring required
portinteger required
database_namestring required
usernamestring required
passwordstring
default_catalogstring nullable
ssl_enabledboolean
ssl_modestring nullable
ssl_ca_certstring nullable
http_pathstring nullable
extra_paramsobject nullable

Response

Successful Response

idinteger required
asset_idinteger required
test_typestring required
statusstring required
started_atstring required
is_successfulboolean nullable
duration_msinteger nullable
error_messagestring nullable
latency_msinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.