Skip to content

Create a new Host.

Request

Security
ApiKeyAuth
Path
environmentIdstring, non-emptyrequired

The ID of the environment.

Bodyapplication/jsonrequired
namestring, non-empty

The name to associate with the host.

hostnamestring, non-empty

The hostname or IP address of this host.

Example:"db1.host.com"
nfs_addressesArray of strings

The list of host/IP addresses to use for NFS export.

Example:
[ "192.168.10.2" ]
ssh_portinteger

The port number used to connect to the host via SSH.

Default:22
Example:22
privilege_elevation_profile_referencestring, non-empty

Reference to a profile for escalating user privileges.

dsp_keystore_aliasstring, non-empty

The lowercase alias to use inside the user managed DSP keystore.

dsp_keystore_passwordstring, (password), non-empty

The password for the user managed DSP keystore.

dsp_keystore_pathstring, non-empty

The path to the user managed DSP keystore.

dsp_truststore_passwordstring, (password), non-empty

The password for the user managed DSP truststore.

dsp_truststore_pathstring, non-empty

The path to the user managed DSP truststore.

java_homestring, non-empty

The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.

toolkit_pathstring, non-empty

The path for the toolkit that resides on the host.

oracle_jdbc_keystore_passwordstring, (password), non-empty

The password for the user managed Oracle JDBC keystore.

oracle_tde_keystores_root_pathstring, non-empty

The path to the root of the Oracle TDE keystores artifact directories.

ssh_verification_strategyobject(SSHVerificationStrategy)

Mechanism to use for ssh host verification.

oracle_cluster_node_virtual_ipsArray of objects(OracleVirtualIP)

The Virtual IP addresses associated with the OracleClusterNode.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2025.2.0.0/continuous-data-apis-dct-2025.2.0.0/environments/{environmentId}/hosts' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "hostname": "db1.host.com",
    "nfs_addresses": [
      "192.168.10.2"
    ],
    "ssh_port": 22,
    "privilege_elevation_profile_reference": "string",
    "dsp_keystore_alias": "string",
    "dsp_keystore_password": "pa$$word",
    "dsp_keystore_path": "string",
    "dsp_truststore_password": "pa$$word",
    "dsp_truststore_path": "string",
    "java_home": "string",
    "toolkit_path": "string",
    "oracle_jdbc_keystore_password": "pa$$word",
    "oracle_tde_keystores_root_path": "string",
    "ssh_verification_strategy": {
      "name": "RAW_KEY",
      "key_type": "RSA",
      "raw_key": "string",
      "fingerprint_type": "SHA256",
      "fingerprint": "string"
    },
    "oracle_cluster_node_virtual_ips": [
      {
        "domain_name": "virtual.domain.com",
        "ip": "192.168.0.1",
        "discovered": true
      }
    ]
  }'

Responses

Host Creation initiated

Bodyapplication/json
jobobject(Job)

An asynchronous task.

cluster_node_idstring

The id of the created cluster node.

Example:"ORACLE_CLUSTER_NODE-7"
Response
{ "job": { "id": "job-123", "status": "RUNNING", "is_waiting_for_telemetry": true, "type": "DB_REFRESH", "localized_type": "DB Refresh", "error_details": "Unable to connect to the engine.", "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.", "target_id": "vdb-123", "target_name": "vdb", "start_time": "2022-01-02T05:11:24.148Z", "update_time": "2022-01-02T06:11:24.148Z", "trace_id": "string", "engine_ids": [ … ], "tags": [ … ], "engines": [ … ], "account_id": 1, "account_name": "User 1", "percent_complete": 50, "virtualization_tasks": [ … ], "tasks": [ … ], "execution_id": "string", "result_type": "string", "result": {} }, "cluster_node_id": "ORACLE_CLUSTER_NODE-7" }