# Tests the validity of the supplied database credentials, returning an error if unable to connect to the database.

Endpoint: POST /database/connectivity/check
Version: 3.18.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Request fields (application/json):

  - `credentials_type` (string, required)
    The type of credentials.
    Enum: "MSSQL_ENVIRONMENT_USER", "MSSQL_DOMAIN_USER", "MSSQL_DATABASE_USER", "ORACLE", "ASE", "SOURCE_CONFIG"

  - `source_id` (string, required)
    Source database config Id.
    Example: 1-SOURCE-CONFIG-1

  - `username` (string)
    Database username (Not applicable for MSSQL_ENVIRONMENT_USER).
    Example: username

  - `password` (string)
    Database password (Not applicable for MSSQL_ENVIRONMENT_USER and mutually exclusive with vault attributes).
    Example: password

  - `vault` (string)
    The name or reference of the vault from which to read the database credentials (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: my-vault

  - `hashicorp_vault_engine` (string)
    Vault engine name where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: kv

  - `hashicorp_vault_secret_path` (string)
    Path in the vault engine where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: oracle-env

  - `hashicorp_vault_username_key` (string)
    Hashicorp vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: username

  - `hashicorp_vault_secret_key` (string)
    Hashicorp vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: secret

  - `azure_vault_name` (string)
    Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: azure_vault

  - `azure_vault_username_key` (string)
    Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: username

  - `azure_vault_secret_key` (string)
    Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: secret

  - `cyberark_vault_query_string` (string)
    Query to find a credential in the CyberArk vault (ORACLE, ASE and MSSQL_DOMAIN_USER only).
    Example: Safe=Test;Folder=Test;Object=Test

  - `environment_id` (string)
    Id of the environment to which environment user belongs (MSSQL_ENVIRONMENT_USER only).

  - `environment_user` (string)
    Reference to the environment user (MSSQL_ENVIRONMENT_USER only).

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `message` (string, required)
    A message describing the result of the connectivity check.
    Example: Success!

  - `status` (string)
    A status describing the status of the connectivity check.
    Enum: "SUCCESS", "FAILED"