Delphix DCT API (3.16.0)

Download OpenAPI specification:Download

Delphix Support: support@delphix.com URL: https://support.delphix.com

Delphix DCT API

External docs

Connectivity

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

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

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

engine_id
required
string

The ID of the engine to check.

use_engine_public_key
boolean

Whether to use public key authentication.

os_name
string

Operating system type of the environment.

Enum: "UNIX" "WINDOWS"
staging_environment
string [ 1 .. 256 ] characters

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

host
required
string

The hostname of the remote host machine to check.

port
required
integer or null [ 0 .. 65535 ]

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

username
string [ 1 .. 255 ] characters

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

password
string [ 1 .. 255 ] characters

The password of the remote host machine to check.

vault_id
string [ 1 .. 256 ] characters

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

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

azure_vault_name
string [ 1 .. 256 ] characters

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

azure_vault_username_key
string [ 1 .. 256 ] characters

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

azure_vault_secret_key
string [ 1 .. 256 ] characters

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

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

use_kerberos_authentication
boolean

Whether to use kerberos authentication.

Responses
200

Success

post/connectivity/check
Request samples
application/json
{
  • "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
}
Response samples
application/json
{
  • "message": "Success!",
  • "status": "SUCCESS"
}

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

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
credentials_type
required
string

The type of credentials.

Enum: "MSSQL_ENVIRONMENT_USER" "MSSQL_DOMAIN_USER" "MSSQL_DATABASE_USER" "ORACLE" "ASE" "SOURCE_CONFIG"
source_id
required
string

Source database config Id.

username
string

Database username (Not applicable for MSSQL_ENVIRONMENT_USER).

password
string

Database password (Not applicable for MSSQL_ENVIRONMENT_USER and mutually exclusive with vault attributes).

vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the database credentials (ORACLE, ASE and MSSQL_DOMAIN_USER only).

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only).

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only).

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

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

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

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

azure_vault_name
string [ 1 .. 256 ] characters

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

azure_vault_username_key
string [ 1 .. 256 ] characters

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

azure_vault_secret_key
string [ 1 .. 256 ] characters

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

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault (ORACLE, ASE and MSSQL_DOMAIN_USER only).

environment_id
string [ 1 .. 256 ] characters

Id of the environment to which environment user belongs (MSSQL_ENVIRONMENT_USER only).

environment_user
string [ 1 .. 256 ] characters

Reference to the environment user (MSSQL_ENVIRONMENT_USER only).

Responses
200

Success

post/database/connectivity/check
Request samples
application/json
{
  • "credentials_type": "MSSQL_ENVIRONMENT_USER",
  • "source_id": "1-SOURCE-CONFIG-1",
  • "username": "username",
  • "password": "password",
  • "vault": "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",
  • "environment_id": "string",
  • "environment_user": "string"
}
Response samples
application/json
{
  • "message": "Success!",
  • "status": "SUCCESS"
}

Checks whether the specified NetBackup master server and client are able to communicate on the given environment.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The api to check connectivity of NetBackup master server and client on an environment.

environment_id
required
string [ 1 .. 256 ] characters

Id of the target environment to test NetBackup connectivity from.

environment_user_id
required
string [ 1 .. 256 ] characters

Id of the environment user.

master_server_name
required
string [ 1 .. 256 ] characters

The name of the NetBackup master server to attempt to connect to.

source_client_name
required
string [ 1 .. 256 ] characters

The name of the NetBackup client to attempt to connect with.

Responses
200

OK

post/netbackup/connectivity/check
Request samples
application/json
{
  • "environment_id": "1-ENVIRONMENT-1",
  • "environment_user_id": "USER-1",
  • "master_server_name": "master_server.delphix.com",
  • "source_client_name": "source_client.delphix.com"
}

Tests whether the CommServe host is accessible from the given environment and Commvault agent.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The api to check connectivity to the CommServe host and staging client from an environment.

environment_id
required
string [ 1 .. 256 ] characters

Id of the target environment to test Commvault connectivity from.

environment_user_id
required
string [ 1 .. 256 ] characters

Id of the environment user.

commserve_host_name
required
string [ 1 .. 256 ] characters

The hostname of the CommServe server to connect to.

source_client_name
required
string [ 1 .. 256 ] characters

The name of the Source Client in CommServe.

staging_client_name
required
string [ 1 .. 256 ] characters

The name of the Staging Client in CommServe.

Responses
200

OK

post/commvault/connectivity/check
Request samples
application/json
{
  • "environment_id": "1-ENVIRONMENT-1",
  • "environment_user_id": "USER-1",
  • "commserve_host_name": "commserve.delphix.com",
  • "source_client_name": "source_client.delphix.com",
  • "staging_client_name": "staging_client.delphix.com"
}
➔ Next to DataLayouts