The Data Control Tower (DCT) Continuous Data API provisions and manages virtual databases (VDBs), links production dSources, orchestrates snapshots, bookmarks, timeflows, VDB groups, environments, replication, and virtualization policies across Oracle, SQL Server, SAP ASE, PostgreSQL, and AppData sources. OpenAPI 3.0.0, base path /dct/v3, API-key authentication.
openapi: 3.0.0
info:
title: Delphix DCT API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
paths:
/connectivity/check:
post:
tags:
- Connectivity
summary: >-
Checks connectivity between an engine and a remote host machine on a
given port.
operationId: connectivity_check
requestBody:
content:
application/json:
schema:
x-body-name: connectivity_check
$ref: '#/components/schemas/ConnectivityCheckParameters'
description: >-
The api to check connectivity of engine and a remote host on given
port.
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
/database/connectivity/check:
post:
tags:
- Connectivity
summary: >-
Tests the validity of the supplied database credentials, returning an
error if unable to connect to the database.
operationId: database_connectivity_check
requestBody:
content:
application/json:
schema:
x-body-name: database_connectivity_check
$ref: '#/components/schemas/DatabaseConnectivityCheckParameters'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
/netbackup/connectivity/check:
post:
tags:
- Connectivity
summary: >-
Checks whether the specified NetBackup master server and client are able
to communicate on the given environment.
operationId: netbackup_connectivity_check
requestBody:
content:
application/json:
schema:
x-body-name: netbackup_connectivity_check
$ref: '#/components/schemas/NetbackupConnectivityCheckParameters'
description: >-
The api to check connectivity of NetBackup master server and client on
an environment.
required: true
responses:
'200':
description: OK
/commvault/connectivity/check:
post:
tags:
- Connectivity
summary: >-
Tests whether the CommServe host is accessible from the given
environment and Commvault agent.
operationId: commvault_connectivity_check
requestBody:
content:
application/json:
schema:
x-body-name: commvault_connectivity_check
$ref: '#/components/schemas/CommvaultConnectivityCheckParameters'
description: >-
The api to check connectivity to the CommServe host and staging client
from an environment.
required: true
responses:
'200':
description: OK
/data-layouts:
get:
summary: List all data-layout (Self-Service Container/Template).
operationId: get_data_layouts
tags:
- DataLayouts
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dataLayoutSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListDataLayoutResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataLayout'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/data-layouts/search:
post:
summary: Search for data-layouts.
operationId: search_data_layouts
tags:
- DataLayouts
x-filterable:
fields:
id:
type: string
name:
type: string
type:
type: string
engine_id:
type: string
engine_name:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dataLayoutSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchDataLayoutResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataLayout'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/data-layouts/{dataLayoutId}:
parameters:
- $ref: '#/components/parameters/dataLayoutIdParam'
get:
summary: Get a data-layout by ID.
operationId: get_data_layout_by_id
tags:
- DataLayouts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DataLayout'
/data-layouts/{dataLayoutId}/tags:
parameters:
- $ref: '#/components/parameters/dataLayoutIdParam'
post:
tags:
- DataLayouts
summary: Create tags for a data-layout.
operationId: create_data_layout_tags
requestBody:
content:
application/json:
schema:
x-body-name: data_layout_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for data-layout.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- DataLayouts
summary: Get tags for a data-layout.
operationId: get_data_layout_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/data-layouts/{dataLayoutId}/tags/delete:
parameters:
- $ref: '#/components/parameters/dataLayoutIdParam'
post:
tags:
- DataLayouts
summary: Delete tags for a data-layout.
operationId: delete_data_layout_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/data-layouts/{dataLayoutId}/convert-and-drop:
parameters:
- $ref: '#/components/parameters/dataLayoutIdParam'
post:
tags:
- DataLayouts
summary: Convert and drop engine bookmarks and vdb groups for the data-layout.
operationId: convert_and_drop_bookmarks
requestBody:
content:
application/json:
schema:
x-body-name: data_layout_tags
$ref: '#/components/schemas/ConvertDataLayoutRequest'
description: Import engine accounts request.
required: false
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ConvertDataLayoutResponse'
/data-layouts/import-engine-accounts:
post:
tags:
- DataLayouts
summary: Import engine (self-service) accounts.
operationId: import_engine_accounts
requestBody:
content:
application/json:
schema:
x-body-name: import_engine_accounts
$ref: '#/components/schemas/ImportEngineAccountRequest'
description: Import engine accounts request.
required: true
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: ImportEngineAccountsResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/bookmarks:
get:
summary: List all bookmarks.
operationId: get_bookmarks
tags:
- Bookmarks
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/bookmarksSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListBookmarksResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Bookmark'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
post:
tags:
- Bookmarks
summary: Create a bookmark at the current time.
operationId: create_bookmark
requestBody:
$ref: '#/components/requestBodies/CreateBookmark'
responses:
'201':
description: OK
content:
application/json:
schema:
type: object
title: CreateBookmarkResponse
properties:
bookmark:
$ref: '#/components/schemas/Bookmark'
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/bookmarks/search:
post:
summary: Search for bookmarks.
operationId: search_bookmarks
tags:
- Bookmarks
x-filterable:
fields:
id:
type: string
name:
type: string
creation_date:
type: date-time
data_timestamp:
type: date-time
vdb_ids:
type: array[string]
dsource_ids:
type: array[string]
retention:
type: integer
expiration:
type: date
bookmark_source:
type: string
bookmark_status:
type: string
ss_data_layout_id:
type: string
ss_bookmark_reference:
type: string
ss_bookmark_errors:
type: array[string]
bookmark_type:
type: string
timeflow_id:
type: date-time
location:
type: string
vdb_group_id:
type: string
vdb_group_name:
type: string
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
primary_object_id:
type: string
primary_engine_id:
type: string
primary_engine_name:
type: string
primary_bookmark_expiration:
type: date
replicas:
type: array[object]
fields:
replica_id:
type: string
replica_engine_id:
type: string
replica_engine_name:
type: string
replica_namespace_id:
type: string
vdbs:
type: array[object]
fields:
vdb_id:
type: string
vdb_name:
type: string
root_parent_id:
type: string
snapshot_id:
type: string
timeflow_id:
type: string
data_timestamp:
type: date-time
dsources:
type: array[object]
fields:
dsource_id:
type: string
dsource_name:
type: string
snapshot_id:
type: string
timeflow_id:
type: string
data_timestamp:
type: date-time
paas_databases:
type: array[object]
fields:
paas_database_id:
type: string
paas_database_name:
type: string
root_parent_id:
type: string
paas_snapshot_id:
type: string
data_timestamp:
type: date-time
paas_instances:
type: array[object]
fields:
paas_instance_id:
type: string
paas_instance_name:
type: string
root_parent_id:
type: string
paas_snapshot_id:
type: string
data_timestamp:
type: date-time
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/bookmarksSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchBookmarksResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Bookmark'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/bookmarks/{bookmarkId}:
parameters:
- $ref: '#/components/parameters/bookmarkIdParam'
get:
summary: Get a bookmark by ID.
operationId: get_bookmark_by_id
tags:
- Bookmarks
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Bookmark'
patch:
summary: Update a bookmark
operationId: update_bookmark
tags:
- Bookmarks
requestBody:
content:
application/json:
schema:
x-body-name: update_bookmark_parameter
$ref: '#/components/schemas/UpdateBookmarkParameters'
description: The new data to update a Bookmark.
responses:
'200':
description: Bookmark update initiated.
content:
application/json:
schema:
type: object
title: UpdateBookmarkResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
delete:
summary: Delete a bookmark.
operationId: delete_bookmark
tags:
- Bookmarks
responses:
'200':
description: Bookmark deleted.
content:
application/json:
schema:
type: object
title: DeleteBookmarkResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/bookmarks/{bookmarkId}/vdb-groups:
parameters:
- $ref: '#/components/parameters/bookmarkIdParam'
get:
summary: List VDB Groups compatible with this bookmark.
operationId: get_vdb_groups_by_bookmark
tags:
- Bookmarks
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbGroupsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListVDBGroupsByBookmarkResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDBGroup'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/bookmarks/{bookmarkId}/vdb-groups/search:
parameters:
- $ref: '#/components/parameters/bookmarkIdParam'
post:
summary: Search for VDB Groups compatible with this bookmark.
operationId: search_vdb_groups_by_bookmark
tags:
- Bookmarks
x-filterable:
fields:
id:
type: string
name:
type: string
database_type:
type: string
status:
type: string
last_successful_refresh_to_bookmark_id:
type: string
last_successful_refresh_time:
type: string
vdb_ids:
type: array[string]
logsync_enabled:
x-internal: true
type: boolean
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbGroupsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchVDBGroupsByBookmarkResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDBGroup'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/bookmarks/{bookmarkId}/tags:
parameters:
- $ref: '#/components/parameters/bookmarkIdParam'
post:
tags:
- Bookmarks
summary: Create tags for a Bookmark.
operationId: create_bookmark_tags
requestBody:
content:
application/json:
schema:
x-body-name: bookmark_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Bookmark.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- Bookmarks
summary: Get tags for a Bookmark.
operationId: get_bookmark_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/bookmarks/{bookmarkId}/tags/delete:
parameters:
- $ref: '#/components/parameters/bookmarkIdParam'
post:
tags:
- Bookmarks
summary: Delete tags for a Bookmark.
operationId: delete_bookmark_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/bookmarks/import-engine-bookmarks/{engineId}:
parameters:
- $ref: '#/components/parameters/engineIdParam'
post:
summary: Import engine bookmarks to DCT.
operationId: import_engine_bookmarks
tags:
- Bookmarks
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ImportEngineBookmarkResponse'
/sources:
get:
summary: List all sources.
operationId: get_sources
tags:
- Sources
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/sourcesSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListSourcesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Source'
errors:
$ref: '#/components/schemas/Errors'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/sources/oracle:
post:
tags:
- Sources
summary: Create an Oracle Source.
operationId: create_oracle_source
requestBody:
$ref: '#/components/requestBodies/CreateOracleSourceBody'
responses:
'201':
description: Oracle Source creation initiated
content:
application/json:
schema:
type: object
title: CreateOracleSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-ORACLE_SINGLE_CONFIG-32
/sources/oracle/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an Oracle source by ID.
operationId: update_oracle_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateOracleSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateOracleSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/{sourceId}/jdbc-check:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
post:
tags:
- Sources
summary: Verify JDBC connection string for a source.
operationId: verify_source_jdbc_connection_string
requestBody:
$ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
responses:
'200':
description: Success or Failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
/sources/postgres:
post:
summary: Create a PostgreSQL source.
operationId: create_postgres_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreatePostgresSource'
responses:
'201':
description: PostgreSQL Source creation initiated
content:
application/json:
schema:
type: object
title: CreatePostgresSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: source-1
/sources/appdata:
post:
summary: Create an AppData source.
operationId: create_app_data_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateAppDataSource'
responses:
'201':
description: AppData Source creation initiated
content:
application/json:
schema:
type: object
title: CreateAppDataSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: source-1
/sources/appdata/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update a AppData source by ID.
operationId: update_appdata_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateAppDataSource'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateAppDataSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/postgres/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update a PostgreSQL source by ID.
operationId: update_postgres_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdatePostgresSource'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdatePostgresSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/ase:
post:
summary: Create an ASE source.
operationId: create_ase_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateAseSourceBody'
responses:
'201':
description: Sybase ASE Source creation initiated
content:
application/json:
schema:
type: object
title: CreateAseSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-source-3
/sources/mssql:
post:
summary: Create an MSSQL source.
operationId: create_mssql_source
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/CreateMssqlSourceBody'
responses:
'201':
description: MSSQL Source creation initiated
content:
application/json:
schema:
type: object
title: CreateMssqlSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
source_id:
type: string
description: The id of the created source.
example: 1-source-3
/sources/ase/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an ASE source by ID.
operationId: update_ase_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateAseSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateAseSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/mssql/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
summary: Update an MSSQL source by ID.
operationId: update_mssql_source_by_id
tags:
- Sources
requestBody:
$ref: '#/components/requestBodies/UpdateMssqlSourceBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateMssqlSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/search:
post:
summary: Search for Sources.
operationId: search_sources
tags:
- Sources
x-filterable:
fields:
id:
type: string
database_type:
type: string
name:
type: string
database_version:
type: string
environment_id:
type: string
environment_name:
type: string
data_uuid:
type: string
ip_address:
type: string
fqdn:
type: string
size:
type: integer
jdbc_connection_string:
type: string
plugin_version:
type: string
is_dsource:
type: boolean
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
recovery_model:
type: string
mssql_source_type:
type: string
appdata_source_type:
type: string
is_pdb:
type: boolean
instance_name:
type: string
instance_number:
type: integer
user:
type: string
environment_user_ref:
type: string
non_sys_user:
type: string
discovered:
type: boolean
linking_enabled:
type: boolean
repository:
type: string
cdb_type:
type: string
data_connection_id:
type: string
database_name:
type: string
database_unique_name:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/sourcesSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchSourcesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Source'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/sources/{sourceId}:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
get:
summary: Get a source by ID.
operationId: get_source_by_id
tags:
- Sources
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
delete:
summary: Delete a source by ID.
operationId: delete_source
tags:
- Sources
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DeleteSourceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/sources/{sourceId}/update:
parameters:
- $ref: '#/components/parameters/sourceIdParam'
patch:
deprecated: true
summary: Update a Source.
tags:
- Sources
operationId: update_source_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_source_parameter
$ref: '#/components/schemas/UpdateSourceParameters'
description: The parameters to updat
# --- truncated at 32 KB (1178 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-continuous-data-openapi.yml