Skip to content
/
Create a Hyperscale Conne...

Create a Hyperscale Connector.

Request

Security
ApiKeyAuth
Bodyapplication/jsonrequired
hyperscale_instance_idstring

The ID of the Hyperscale instance of this Connector.

data_typestring(HyperscaleDataTypeEnum)

The data type designation for the hyperscale deployment.

Enum:"ORACLE""MSSQL""DELIMITED_FILES""MONGO_DB"
Example:"ORACLE"
namestring
source_usernamestring

The username this Connector will use to connect to the source database.

source_passwordstring

The password this Connector will use to connect to the source database.

source_jdbc_urlstring

The JDBC URL used to connect to the source database.

source_mongo_urlstring

The MongoDB URL used to connect to the source database.

Example:"mongodb://host:27017"
source_filesystem_pathstring

The path on the filesystem where source files must be read (Delimited files Only).

source_connection_propertiesobject
target_usernamestring

The username this Connector will use to connect to the target database.

target_passwordstring

The username this Connector will use to connect to the target database.

target_jdbc_urlstring

The JDBC URL used to connect to the target database.

target_mongo_urlstring

The MongoDB URL used to connect to the target database.

Example:"mongodb://host:27017"
target_filesystem_pathstring

The path on the filesystem where target files must be written (Delimited files Only).

target_connection_propertiesobject
tagsArray of objects(Tag)
make_current_account_ownerboolean

Whether the account creating this Hyperscale Connector must be configured as owner of it.

Default:true
curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/2025.4.0.0/continuous-compliance-apis-dct-2025.4.0.0/hyperscale-connectors \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "hyperscale_instance_id": "string",
    "data_type": "ORACLE",
    "name": "string",
    "source_username": "string",
    "source_password": "string",
    "source_jdbc_url": "string",
    "source_mongo_url": "mongodb://host:27017",
    "source_filesystem_path": "string",
    "source_connection_properties": {
      "property1": "string",
      "property2": "string"
    },
    "target_username": "string",
    "target_password": "string",
    "target_jdbc_url": "string",
    "target_mongo_url": "mongodb://host:27017",
    "target_filesystem_path": "string",
    "target_connection_properties": {
      "property1": "string",
      "property2": "string"
    },
    "tags": [
      {
        "key": "key-1",
        "value": "value-1"
      }
    ],
    "make_current_account_owner": true
  }'

Responses

OK

Bodyapplication/json
idstring

The created Hyperscale Connector's ID.

jobobject(Job)

The initiated job.

Response
{
  "id": "string",
  "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.148000+00:00",
    "update_time": "2022-01-02T06:11:24.148000+00:00",
    "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": {}
  }
}