Skip to content
/
Refresh a VDB by timestam...

Refresh a VDB by timestamp.

Request

Security
ApiKeyAuth
Path
vdbIdstring, non-emptyrequired

The ID of the VDB.

Bodyapplication/json

The parameters to refresh a VDB.

timestampstring, (date-time)

The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point.

Example:"2021-05-01T08:51:34.148Z"
timestamp_in_database_timezonestring[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:...

The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

Example:"2021-08-14T14:55:20.507Z"
timeflow_idstring, [ 1 .. 256 ] characters

The Timeflow ID.

Example:"timeflow_123"
dataset_idstring, [ 1 .. 256 ] characters

ID of the dataset to refresh to, mutually exclusive with timeflow_id.

Example:"123-CONTAINER_1"
curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2026.5.0.0/continuous-data-apis-dct-2026.5.0.0/vdbs/{vdbId}/refresh_by_timestamp' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "timestamp": "2021-05-01T08:51:34.148Z",
    "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
    "timeflow_id": "timeflow_123",
    "dataset_id": "123-CONTAINER_1"
  }'

Responses

VDB refresh 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"
  }
}