Skip to content
/
Refresh a VDBGroup from b...

Refresh a VDBGroup from bookmark.
deprecated

Request

This API is marked as deprecated in favour of renamed API '/vdb-groups/{vdbGroupId}/refresh_from_bookmark'

Security
ApiKeyAuth
Path
vdbGroupIdstring, [ 1 .. 256 ] charactersrequired

The ID or name of the VDBGroup.

Bodyapplication/json

The parameters to refresh a VDBGroup.

bookmark_idstring, [ 1 .. 256 ] charactersrequired

ID of a bookmark to refresh this VDB Group to.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/vdb-groups/{vdbGroupId}/refresh' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "bookmark_id": "string"
  }'

Responses

VDBGroup 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",
    "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"
  }
}