The Data Control Tower (DCT) Continuous Compliance API automates sensitive-data discovery, masking, and synthetic data generation to protect PII in non-production environments. It manages masking jobs, rulesets, algorithms, connectors, and compliance engines. 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:
/hyperscale-instances:
post:
tags:
- HyperscaleInstance
summary: Register a Hyperscale instance
operationId: register_hyperscale_instance
parameters:
- in: query
name: validate_instance
required: false
schema:
type: boolean
default: false
description: >-
If true, validates the registering hyperscale orchestrator and
identify dataType.
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_instance
$ref: '#/components/schemas/HyperscaleInstanceRegistrationParameter'
description: The parameters to register a Hyperscale instance.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleInstance'
get:
tags:
- HyperscaleInstance
summary: Returns a list of Hyperscale instances.
operationId: get_hyperscale_instances
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleInstancesSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListHyperscaleInstancesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleInstance'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-instances/search:
post:
summary: Search for Hyperscale instances.
operationId: search_hyperscale_instances
tags:
- HyperscaleInstance
x-filterable:
fields:
id:
type: string
name:
type: string
hostname:
type: string
creation_date:
type: string
data_type:
type: string
insecure_ssl:
type: boolean
unsafe_ssl_hostname_check:
type: boolean
status:
type: string
connection_status:
type: string
connection_status_details:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleInstancesSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchHyperscaleInstancesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleInstance'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-instances/{hyperscaleInstanceId}:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
get:
tags:
- HyperscaleInstance
summary: Returns a Hyperscale Instance by ID.
operationId: get_hyperscale_instance_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleInstance'
patch:
tags:
- HyperscaleInstance
summary: Update an Hyperscale Instance
operationId: update_hyperscale_instance
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_instance_update_params
$ref: '#/components/schemas/HyperscaleInstanceUpdateParams'
description: Update parameters for a hyperscale instance.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleInstance'
delete:
tags:
- HyperscaleInstance
summary: Unregister a Hyperscale Instance.
operationId: unregister_hyperscale_instance
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UnregisterHyperscaleInstanceResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/hyperscale-instances/{hyperscaleInstanceId}/tags:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
post:
tags:
- HyperscaleInstance
summary: Create tags for a Hyperscale Instance.
operationId: create_hyperscale_instance_tags
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_instance_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Hyperscale Instance.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- HyperscaleInstance
summary: Get tags for a Hyperscale Instance.
operationId: get_hyperscale_instance_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/hyperscale-instances/{hyperscaleInstanceId}/tags/delete:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
post:
tags:
- HyperscaleInstance
summary: Delete tags for a Hyperscale Instance.
operationId: delete_hyperscale_instance_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/hyperscale-instances/{hyperscaleInstanceId}/sync-engines:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
post:
tags:
- HyperscaleInstance
summary: >-
Sync the global object from a source engine to engines on a Hyperscale
Instance.
operationId: sync_engines_hyperscale_instance
requestBody:
content:
application/json:
schema:
x-body-name: sync_engines_hyperscale_parameter
$ref: '#/components/schemas/SyncEnginesHyperscaleParameters'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SyncEnginesHyperscaleResponse
properties:
job:
$ref: '#/components/schemas/Job'
/hyperscale-instances/{hyperscaleInstanceId}/add-engine:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
post:
tags:
- HyperscaleInstance
summary: Add an engine to a Hyperscale Instance.
operationId: add_engine_to_hyperscale_instance
requestBody:
content:
application/json:
schema:
x-body-name: engine_id
$ref: '#/components/schemas/EngineIdBody'
description: Body containing the ID of the registered engine.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: AddEngineToHyperscaleResponse
properties:
job:
$ref: '#/components/schemas/Job'
/hyperscale-instances/{hyperscaleInstanceId}/remove-engine:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
post:
tags:
- HyperscaleInstance
summary: Remove an engine from a Hyperscale Instance.
operationId: remove_engine_from_hyperscale_instance
requestBody:
content:
application/json:
schema:
x-body-name: engine_id
$ref: '#/components/schemas/EngineIdBody'
description: Body containing the ID of the registered engine.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RemoveEngineFromHyperscaleResponse
properties:
job:
$ref: '#/components/schemas/Job'
/hyperscale-instances/{hyperscaleInstanceId}/move-to-job-orchestrator:
parameters:
- $ref: '#/components/parameters/hyperscaleInstanceId'
put:
tags:
- HyperscaleInstance
summary: >-
Move compliance nodes from a hyperscale orchestrator to a job
orchestrator.
operationId: move_compliance_nodes_to_job_orchestrator
requestBody:
content:
application/json:
schema:
x-body-name: move_to_job_orchestrator_request
$ref: '#/components/schemas/MoveComplianceNodesToJobOrchestratorRequest'
description: The parameters to move compliance nodes to a job orchestrator.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoveComplianceNodesResponse'
/hyperscale-mount-points:
get:
tags:
- HyperscaleObjects
summary: Returns a list of Hyperscale Mount Points.
operationId: get_hyperscale_mount_points
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleMountPointsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListHyperscaleMountPointsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleMountPoint'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
post:
tags:
- HyperscaleObjects
summary: Create a Hyperscale Mount Point
operationId: create_hyperscale_mount_point
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_mount_point
$ref: '#/components/schemas/HyperscaleMountPoint'
description: Request to create a Hyperscale Mount Point.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: CreateHyperscaleMountPointResponse
properties:
id:
type: string
description: The created Hyperscale Mount Point's ID
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/hyperscale-mount-points/{hyperscaleMountPointId}:
parameters:
- $ref: '#/components/parameters/hyperscaleMountPointIdParam'
get:
tags:
- HyperscaleObjects
summary: Get a Hyperscale Mount Points.
operationId: get_hyperscale_mount_point_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleMountPoint'
patch:
tags:
- HyperscaleObjects
summary: Update a Hyperscale Mount Point by ID.
operationId: update_hyperscale_mount_point_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_hyperscale_mount_point_parameter
$ref: '#/components/schemas/HyperscaleMountPointUpdateParameters'
description: The new data to update a Hyperscale Mount Point.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateHyperscaleMountPointResponse
properties:
job:
$ref: '#/components/schemas/Job'
delete:
tags:
- HyperscaleObjects
summary: Delete a Hyperscale Mount Point.
operationId: delete_hyperscale_mount_point
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DeleteHyperscaleMountPointResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/hyperscale-mount-points/{hyperscaleMountPointId}/validate:
parameters:
- $ref: '#/components/parameters/hyperscaleMountPointIdParam'
get:
tags:
- HyperscaleObjects
summary: Validate the permissions for the Hyperscale Mount Point.
operationId: validate_hyperscale_mount_point
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/ValidateHyperscaleMountPointResponse'
/hyperscale-mount-points/search:
post:
summary: Search for Hyperscale Mount Points.
operationId: search_hyperscale_mount_points
tags:
- HyperscaleObjects
x-filterable:
fields:
id:
type: string
hyperscale_instance_id:
type: string
name:
type: string
hostname:
type: string
mount_type:
type: string
mount_path:
type: string
options:
type: string
staging_storage_type:
type: string
auth_mechanism:
type: string
aws_bucket_name:
type: string
aws_bucket_region:
type: string
aws_bucket_prefix:
type: string
aws_bucket_delimiter:
type: string
blob_auth_type:
type: string
blob_account_name:
type: string
blob_container_name:
type: string
blob_container_prefix:
type: string
blob_container_delimiter:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleMountPointsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchHyperscaleMountPointsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleMountPoint'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/mount-filesystem/{mountInformationId}/tags:
parameters:
- $ref: '#/components/parameters/mountInformationIdParam'
/mount-filesystem/{mountInformationId}/tags/delete:
parameters:
- $ref: '#/components/parameters/mountInformationIdParam'
/mount-filesystem/{mountInformationId}:
parameters:
- $ref: '#/components/parameters/mountInformationIdParam'
/hyperscale-connectors:
get:
tags:
- HyperscaleObjects
summary: Returns a list of Hyperscale Connectors.
operationId: get_hyperscale_connectors
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleConnectorsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListHyperscaleConnectorsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleConnector'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
post:
tags:
- HyperscaleObjects
summary: Create a Hyperscale Connector.
operationId: create_hyperscale_connector
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_connector
$ref: '#/components/schemas/HyperscaleConnectorCreateParameters'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: CreateHyperscaleConnectorResponse
properties:
id:
type: string
description: The created Hyperscale Connector's ID.
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/hyperscale-connectors/{hyperscaleConnectorId}:
parameters:
- $ref: '#/components/parameters/hyperscaleConnectorIdParam'
get:
tags:
- HyperscaleObjects
summary: Get a Hyperscale Connector.
operationId: get_hyperscale_connector_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleConnector'
patch:
tags:
- HyperscaleObjects
summary: Update a Hyperscale Connector by ID.
operationId: update_hyperscale_connector_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_hyperscale_connector_parameter
$ref: '#/components/schemas/HyperscaleConnectorUpdateParameters'
description: The new data to update a Hyperscale Connector.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateHyperscaleConnectorResponse
properties:
job:
$ref: '#/components/schemas/Job'
delete:
tags:
- HyperscaleObjects
summary: Delete a Hyperscale Connector.
operationId: delete_hyperscale_connector
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DeleteHyperscaleConnectorResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/hyperscale-connectors/{hyperscaleConnectorId}/tags:
parameters:
- $ref: '#/components/parameters/hyperscaleConnectorIdParam'
post:
tags:
- HyperscaleObjects
summary: Create tags for a Hyperscale Connector.
operationId: create_hyperscale_connector_tags
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_connector_tags
$ref: '#/components/schemas/TagsRequest'
description: Tag information for a Hyperscale Connector.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- HyperscaleObjects
summary: Get tags for a Hyperscale Connector.
operationId: get_hyperscale_connector_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/hyperscale-connectors/{hyperscaleConnectorId}/tags/delete:
parameters:
- $ref: '#/components/parameters/hyperscaleConnectorIdParam'
post:
tags:
- HyperscaleObjects
summary: Delete tags for a Hyperscale Connector.
operationId: delete_hyperscale_connector_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/hyperscale-connectors/search:
post:
summary: Search for Hyperscale Connectors.
operationId: search_hyperscale_connectors
tags:
- HyperscaleObjects
x-filterable:
fields:
id:
type: string
name:
type: string
hyperscale_instance_id:
type: string
data_type:
type: string
source_username:
type: string
source_jdbc_url:
type: string
source_mongo_url:
type: string
source_filesystem_path:
type: string
target_username:
type: string
target_jdbc_url:
type: string
target_mongo_url:
type: string
target_filesystem_path:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleConnectorsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchHyperscaleConnectorsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleConnector'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-datasets:
get:
tags:
- HyperscaleObjects
summary: Returns a list of Hyperscale Datasets.
operationId: get_hyperscale_datasets
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleDatasetsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListHyperscaleDatasetsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleDataset'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-datasets/{hyperscaleDatasetId}:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
get:
tags:
- HyperscaleObjects
summary: Get a Hyperscale Dataset.
operationId: get_hyperscale_dataset_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleDataset'
patch:
tags:
- HyperscaleObjects
summary: Update a Hyperscale Dataset by ID.
operationId: update_hyperscale_dataset_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_hyperscale_dataset_parameter
$ref: '#/components/schemas/HyperscaleDatasetUpdateParameters'
description: The new data to update a Hyperscale Dataset.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateHyperscaleDatasetResponse
properties:
job:
$ref: '#/components/schemas/Job'
/hyperscale-datasets/{hyperscaleDatasetId}/tags:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
post:
tags:
- HyperscaleObjects
summary: Create tags for a Hyperscale Dataset.
operationId: create_hyperscale_dataset_tags
requestBody:
content:
application/json:
schema:
x-body-name: hyperscale_dataset_tags
$ref: '#/components/schemas/TagsRequest'
description: Tag information for a Hyperscale Dataset.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- HyperscaleObjects
summary: Get tags for a Hyperscale Dataset.
operationId: get_hyperscale_dataset_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/hyperscale-datasets/{hyperscaleDatasetId}/tags/delete:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
post:
tags:
- HyperscaleObjects
summary: Delete tags for a Hyperscale Dataset.
operationId: delete_hyperscale_dataset_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId}:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
- $ref: '#/components/parameters/hyperscaleDatasetTableOrFileIdParam'
get:
tags:
- HyperscaleObjects
summary: Get a Hyperscale Dataset table or file by ID.
operationId: get_hyperscale_dataset_table_or_file_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
patch:
tags:
- HyperscaleObjects
summary: Update a Hyperscale Dataset table or file by ID.
operationId: update_hyperscale_dataset_table_or_file_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_hyperscale_dataset_table_or_file_parameter
$ref: >-
#/components/schemas/HyperscaleDatasetTableOrFileUpdateParameters
description: The new data to update a Hyperscale Dataset table or file.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateHyperscaleDatasetTableOrFileResponse
properties:
job:
$ref: '#/components/schemas/Job'
/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleDatasetTablesOrFilesSortParam'
get:
tags:
- HyperscaleObjects
summary: Get the tables or files of a hyperscale dataset
operationId: get_hyperscale_dataset_tables_or_files
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListHyperscaleDatasetTablesOrFilesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/search:
parameters:
- $ref: '#/components/parameters/hyperscaleDatasetIdParam'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleDatasetTablesOrFilesSortParam'
post:
tags:
- HyperscaleObjects
x-filterable:
fields:
id:
type: string
schema_name:
type: string
table_name:
type: string
filter_key:
type: string
column_array_rows:
type: integer
unload_split:
type: integer
stream_size:
type: integer
masking_inventory:
type: array[object]
fields:
field_name:
type: string
domain_name:
type: string
algorithm_name:
type: string
date_format:
type: string
algorithm_field_name:
type: string
algorithm_group_no:
type: integer
summary: Search the tables or files of a hyperscale dataset
operationId: search_hyperscale_dataset_tables_or_files
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchHyperscaleDatasetTablesOrFilesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/hyperscale-datasets/search:
post:
summary: Search for Hyperscale Datasets.
operationId: search_hyperscale_datasets
tags:
- HyperscaleObjects
x-filterable:
fields:
id:
type: string
hyperscale_instance_id:
type: string
data_type:
type: string
mount_point_id:
type: string
connector_id:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/hyperscaleDatasetsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type
# --- truncated at 32 KB (541 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-continuous-compliance-openapi.yml