Patch a synthetic data connector by ID.

Request

Security

ApiKeyAuth

Path

syntheticConnectorIdstring, non-emptyrequired

The id of the synthetic data connector

Bodyapplication/json

The values to update a synthetic data connector.

namestring, [ 1 .. 100 ] characters

The name of this connector. This value must be unique among all synthetic data connectors.

Example:"DB connector 1"

descriptionstring, <= 1000 characters

An optional description for this connector.

Example:"This is first db connector."

jdbc_driver_idstring

The ID of an uploaded JDBC driver. Only applicable for EXTENDED connectors.

is_targetboolean

Indicates if this connector is a target connector.

database_configobject(SyntheticDatabaseConfigPatch)

Database connector config parameters for patch/update requests.

Example:

{
  "authentication_type": "USERNAME_PASSWORD",
  "username": "user1",
  "password": "******",
  "host": "db.example.com",
  "port": 1521,
  "sid": "ORCL"
}

curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2026.5.0.0/continuous-data-apis-dct-2026.5.0.0/synthetic/connectors/{syntheticConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "DB connector 1",
    "description": "This is first db connector.",
    "database_config": {
      "authentication_type": "USERNAME_PASSWORD",
      "username": "user1",
      "password": "******",
      "host": "db.example.com",
      "port": 1521,
      "sid": "ORCL"
    }
  }'

Responses

Synthetic data connector update initiated.

Bodyapplication/json

jobobject(Job)

An asynchronous task.

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",
    "work_source_id": "string",
    "work_source_name": "string",
    "work_source_type": "DIRECT",
    "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",
    "compliance_node_id": "string",
    "compliance_node_name": "string",
    "percent_complete": 50,
    "virtualization_tasks": [ … ],
    "tasks": [ … ],
    "execution_id": "string",
    "result_type": "string",
    "result": {},
    "parent_job_id": "string"
  }
}