Skip to content

Checks connectivity between an engine and a remote host machine on a given port.

Request

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The api to check connectivity of engine and a remote host on given port.

engine_idstringrequired

The ID of the engine to check.

Example:"engine-123"
use_engine_public_keyboolean

Whether to use public key authentication.

Example:true
os_namestring

Operating system type of the environment.

Enum:"UNIX""WINDOWS"
Example:"UNIX"
staging_environmentstring, [ 1 .. 256 ] characters

Id of the connector environment which is used to connect to this source environment.

Example:"1-WINDOWS_HOST-1"
hoststringrequired

The hostname of the remote host machine to check.

Example:"test.host.com"
portinteger or null, [ 0 .. 65535 ]required

The port of the remote host machine to check. For Windows, port on which Delphix connector is running.

Example:22
usernamestring, [ 1 .. 255 ] characters

The username of the remote host machine to check. Username is mandatory input with password/use_engine_public_key/kerberos_authentication.

Example:"username"
passwordstring, [ 1 .. 255 ] characters

The password of the remote host machine to check.

Example:"password"
vault_idstring, [ 1 .. 256 ] characters

The DCT id or name of the vault from which to read the host credentials.

Example:"my-vault"
hashicorp_vault_enginestring, [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

Example:"kv"
hashicorp_vault_secret_pathstring, [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

Example:"oracle-env"
hashicorp_vault_username_keystring, [ 1 .. 256 ] characters

Key for the username in the key-value store.

Example:"username"
hashicorp_vault_secret_keystring, [ 1 .. 256 ] characters

Key for the password in the key-value store.

Example:"secret"
azure_vault_namestring, [ 1 .. 256 ] characters

Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only).

Example:"azure_vault"
azure_vault_username_keystring, [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).

Example:"username"
azure_vault_secret_keystring, [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).

Example:"secret"
cyberark_vault_query_stringstring, [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

Example:"Safe=Test;Folder=Test;Object=Test"
use_kerberos_authenticationboolean

Whether to use kerberos authentication.

Example:true
curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/connectivity/check \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "engine_id": "engine-123",
    "use_engine_public_key": true,
    "os_name": "UNIX",
    "staging_environment": "1-WINDOWS_HOST-1",
    "host": "test.host.com",
    "port": 22,
    "username": "username",
    "password": "password",
    "vault_id": "my-vault",
    "hashicorp_vault_engine": "kv",
    "hashicorp_vault_secret_path": "oracle-env",
    "hashicorp_vault_username_key": "username",
    "hashicorp_vault_secret_key": "secret",
    "azure_vault_name": "azure_vault",
    "azure_vault_username_key": "username",
    "azure_vault_secret_key": "secret",
    "cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
    "use_kerberos_authentication": true
  }'

Responses

Success

Bodyapplication/json
messagestringrequired

A message describing the result of the connectivity check.

Example:"Success!"
statusstring

A status describing the status of the connectivity check.

Enum:"SUCCESS""FAILED"
Example:"SUCCESS"
Response
{
  "message": "Success!",
  "status": "SUCCESS"
}