openapi: 3.0.0
info:
title: Delphix DCT Algorithms Reporting 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
security:
- ApiKeyAuth: []
tags:
- name: Reporting
paths:
/reporting/masking-execution-metrics:
get:
summary: Get the masking execution metrics report.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/maskingExecutionMetricsSortParam'
operationId: get_masking_execution_metrics_report
responses:
'200':
description: Returns a list of Masking execution metrics.
content:
application/json:
schema:
type: object
title: MaskingExecutionMetricsReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/MaskingExecutionMetrics'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'id,masking_job_name,masking_job_type,connector_type,ruleset_name,rows_masked,rows_total,bytes_masked,bytes_total,duration,tables_files_count,"masked_tables_files_count",columns_fields_count,"masked_columns_fields_count"
"4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-job,STANDARD,ORACLE,customers,2,2,0,0,19430,1,1,2,2
'
/reporting/masking-execution-metrics/search:
post:
summary: Search the Masking execution metrics report.
tags:
- Reporting
x-filterable:
fields:
id:
type: string
masking_job_name:
type: string
masking_job_type:
type: string
connector_type:
type: string
dct_managed:
type: boolean
ruleset_name:
type: string
rows_masked:
type: integer
rows_total:
type: integer
bytes_masked:
type: integer
bytes_total:
type: integer
duration:
type: integer
tables_files_count:
type: integer
masked_tables_files_count:
type: integer
columns_fields_count:
type: integer
masked_columns_fields_count:
type: integer
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/maskingExecutionMetricsSortParam'
operationId: search_masking_execution_metrics_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Search Masking execution metrics.
content:
application/json:
schema:
type: object
title: MaskingExecutionMetricsReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/MaskingExecutionMetrics'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'id,masking_job_name,connector_type,ruleset_name,rows_masked,rows_total,bytes_masked,bytes_total,duration,tables_files_count,"masked_tables_files_count",columns_fields_count,"masked_columns_fields_count"
"4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-job,ORACLE,customers,2,2,0,0,19430,1,1,2,2
'
/reporting/{executionId}/generate-pdf-report:
parameters:
- $ref: '#/components/parameters/executionIdParam'
post:
summary: Generate a PDF report for given execution.
operationId: generate_execution_pdf_report
tags:
- Reporting
responses:
'200':
description: PDF Report generation initiated for execution.
content:
application/json:
schema:
type: object
title: GenerateExecutionPdfReportResponse
properties:
job:
$ref: '#/components/schemas/Job'
/reporting/{executionId}/download-pdf-report:
parameters:
- $ref: '#/components/parameters/executionIdParam'
get:
summary: Download PDF report for given execution.
operationId: download_execution_pdf_report
tags:
- Reporting
responses:
'200':
description: PDF file successfully returned
content:
application/pdf:
schema:
type: string
format: binary
/reporting/engine-global-object-state-report:
get:
summary: Get the masking engine global object state report.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/engineGlobalObjectStateReportSortParam'
operationId: get_engine_global_object_state_report
responses:
'200':
description: Returns a list of GlobalObjectState data.
content:
application/json:
schema:
type: object
title: GetEngineGlobalObjectStateReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/EngineGlobalObjectStateData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_id,engine_name,jobs_count,connectors_count,rulesets_count,global_object_revision_hash
"4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-engine-dev,10,25,25,"dfb515e3d9727eebf499cb252b417efc926bad0b"
'
/reporting/engine-global-object-state-report/search:
post:
summary: Search the masking engine global object state report.
tags:
- Reporting
x-filterable:
fields:
engine_id:
type: string
engine_name:
type: string
jobs_count:
type: integer
connectors_count:
type: integer
rulesets_count:
type: integer
global_object_revision_hash:
type: string
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/engineGlobalObjectStateReportSortParam'
operationId: search_engine_global_object_state_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of searched GlobalObjectState data.
content:
application/json:
schema:
type: object
title: SearchEngineGlobalObjectStateReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/EngineGlobalObjectStateData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_id,engine_name,jobs_count,connectors_count,rulesets_count,global_object_revision_hash
"4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-engine-dev,10,25,25,"dfb515e3d9727eebf499cb252b417efc926bad0b"
'
/reporting/data-risk-report:
get:
summary: Get the masking data risk report.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dataRiskReportSortParam'
operationId: get_data_risk_report
responses:
'200':
description: Returns a list of DataRisk data.
content:
application/json:
schema:
type: object
title: GetDataRiskReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataRiskData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
totals:
$ref: '#/components/schemas/DataRiskReportTotals'
text/csv:
schema:
type: string
example: 'connector_id,connector_name,engine_id,engine_name,is_profiled,is_sensitive_data,is_masked,is_at_risk
"4ed2357d-f1a7-410c-b951-90f0edc1a0f6",my-connector,"dfb515e3d9727eebf499cb252b417efc926bad0b",my-engine,true,true,true,false
'
/reporting/data-risk-report/search:
post:
summary: Search the masking data risk report.
tags:
- Reporting
x-filterable:
fields:
connector_id:
type: string
engine_connector_id:
type: integer
connector_name:
type: string
connector_type:
type: string
last_profiled_date:
type: string
last_masked_date:
type: string
dct_managed:
type: boolean
engine_id:
type: string
engine_name:
type: string
is_profiled:
type: boolean
is_sensitive_data:
type: boolean
is_masked:
type: boolean
is_at_risk:
type: boolean
data_elements_total:
type: integer
data_elements_not_sensitive:
type: integer
data_elements_sensitive_masked:
type: integer
data_elements_sensitive_unmasked:
type: integer
records_total:
type: integer
records_not_sensitive:
type: integer
records_sensitive_masked:
type: integer
records_sensitive_unmasked:
type: integer
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dataRiskReportSortParam'
operationId: search_data_risk_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of searched DataRisk data.
content:
application/json:
schema:
type: object
title: SearchDataRiskReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataRiskData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
totals:
$ref: '#/components/schemas/DataRiskReportTotals'
text/csv:
schema:
type: string
example: 'connector_id,engine_connector_id,connector_name,engine_id,engine_name,is_profiled,is_sensitive_data,is_masked,is_at_risk
"1-DATABASE-15",15,my-connector,"1",my-engine,true,true,true,false
'
/reporting/storage-savings-report/search:
post:
summary: Search the saving storage summary report for virtualization engines.
tags:
- Reporting
x-filterable:
fields:
dsource_id:
type: string
dependant_vdbs:
type: integer
engine_name:
type: string
unvirtualized_space:
type: integer
current_timeflows_unvirtualized_space:
type: integer
virtualized_space:
type: integer
name:
type: string
estimated_savings:
type: integer
estimated_savings_perc:
type: number
estimated_current_timeflows_savings:
type: integer
estimated_current_timeflows_savings_perc:
type: number
is_replica:
type: boolean
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/storageSavingsReportSortParam'
operationId: search_storage_savings_summary_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of saving storage summary data of virtualization engines.
content:
application/json:
schema:
type: object
title: StorageSavingsSummaryReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/StorageSavingsSummaryData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
totals:
$ref: '#/components/schemas/StorageSavingsReportSummarizedData'
text/csv:
schema:
type: string
example: 'dsource_id,dependant_vdbs,engine_name,unvirtualized_space,virtualized_space,name,estimated_savings,estimated_savings_perc
2-MSSQL_DB_CONTAINER-1.1,my-engine,23404216320,20896169984,testdb,524496896,99.70111311277408
'
/reporting/vdb-inventory-report:
get:
summary: Gets the inventory report for virtualization engine VDBs.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbInventoryReportSortParam'
operationId: get_vdb_inventory_report
responses:
'200':
description: Returns a list of inventory data of VDBs.
content:
application/json:
schema:
type: object
title: VDBInventoryReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDBInventoryData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_name,name,type,version,parent_name,parent_id,creation_date,parent_timeflow_location,parent_timeflow_timestamp,parent_timeflow_timezone,enabled,status,storage_size
engine1,VDB-1,Oracle,10.2.0.5,dSource 1,1-Container-1,2022-01-07T12:06:59.157Z,54321,2022-02-07T12:03:15.821Z,"America/New_York",EDT-0400,true,Running,123456
'
/reporting/vdb-inventory-report/search:
post:
summary: Search the inventory report for virtualization engine VDBs.
tags:
- Reporting
x-filterable:
fields:
name:
type: string
type:
type: string
version:
type: string
parent_name:
type: string
parent_id:
type: string
creation_date:
type: string
last_refreshed_date:
type: string
parent_timeflow_location:
type: string
parent_timeflow_timestamp:
type: string
parent_timeflow_timezone:
type: string
enabled:
type: boolean
status:
type: string
engine_name:
type: string
storage_size:
type: string
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vdbInventoryReportSortParam'
operationId: search_vdb_inventory_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of inventory data of VDBs.
content:
application/json:
schema:
type: object
title: VDBInventoryReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VDBInventoryData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_name,name,type,version,parent_name,parent_id,creation_date,parent_timeflow_location,parent_timeflow_timestamp,parent_timeflow_timezone,enabled,status
engine1,VDB-1,Oracle,10.2.0.5,dSource 1,1-Container-1,2022-01-07T12:06:59.157Z,54321,2022-02-07T12:03:15.821Z,"America/New_York",EDT-0400,true,Running
'
/reporting/dsource-usage-report:
get:
summary: Gets the usage report for virtualization engine dSources.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dSourceUsageReportSortParam'
operationId: get_dsource_usage_report
responses:
'200':
description: Returns a list of dSource usage data.
content:
application/json:
schema:
type: object
title: DSourceUsageReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DSourceUsageData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_name,name,unvirtualized_space,actual_space,dependant_vdbs
engine1,prod01,1849457664,607240704,0
engine2,test03,1696232960,1290392576,2
'
/reporting/dsource-usage-report/search:
post:
summary: Search the usage report for virtualization engine dSources.
tags:
- Reporting
x-filterable:
fields:
name:
type: string
unvirtualized_space:
type: integer
actual_space:
type: integer
dependant_vdbs:
type: integer
engine_name:
type: string
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dSourceUsageReportSortParam'
operationId: search_dsource_usage_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of dSource usage data.
content:
application/json:
schema:
type: object
title: DSourceUsageReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DSourceUsageData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'engine_name,name,unvirtualized_space,actual_space,dependant_vdbs
engine1,prod01,1849457664,607240704,0
engine2,test03,1696232960,1290392576,2
'
/reporting/dsource-consumption-report:
get:
summary: Gets the consumption report for virtualization engine dSources.
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dSourceConsumptionReportSortParam'
operationId: get_dsource_consumption_report
responses:
'200':
description: Returns a list of dSource consumption data.
content:
application/json:
schema:
type: object
title: DSourceConsumptionReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DSourceConsumptionData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'name,status,database_type,engine_id,engine_name,last_consumption_date,ingested_size
dsource1,Running,Oracle,1,engine1,2022-05-29T15:00:00-04:00,12345
dsource2,Stopped,SQL Server,1,engine2,2022-05-29T15:00:00-04:00,12345
'
/reporting/dsource-consumption-report/search:
post:
summary: Search the consumption report for virtualization engine DSources.
tags:
- Reporting
x-filterable:
fields:
name:
type: string
status:
type: string
database_type:
type: string
engine_id:
type: string
engine_name:
type: string
last_consumption_date:
type: string
format: date-time
ingested_size:
type: integer
parameters:
- $ref: '#/components/parameters/limitExtendedParam'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/dSourceConsumptionReportSortParam'
operationId: search_dsource_consumption_report
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns a list of dSource consumption data.
content:
application/json:
schema:
type: object
title: DSourceConsumptionReportResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DSourceConsumptionData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
text/csv:
schema:
type: string
example: 'name,status,database_type,engine_id,engine_name,last_consumption_date,ingested_size
dsource1,Running,Oracle,1,engine1,2022-05-29T15:00:00-04:00,12345
dsource2,Stopped,SQL Server,1,engine2,2022-05-29T15:00:00-04:00,12345
'
/reporting/storage-capacity-data-report:
get:
tags:
- Reporting
summary: Get engine storage capacity data.
operationId: get_storage_capacity_data
parameters:
- $ref: '#/components/parameters/engineIdQueryParam'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/engineStorageCapacityDataSortParam'
responses:
'200':
description: Returns the engine storage capacity data.
content:
application/json:
schema:
type: object
title: EngineStorageCapacityDataResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/EngineStorageCapacityData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/reporting/storage-capacity-data-report/search:
post:
tags:
- Reporting
summary: Search engine storage capacity data.
operationId: search_storage_capacity_data
x-filterable:
fields:
engine_id:
type: string
dataset_id:
type: string
captured_timestamp:
type: string
format: date-time
dataset_type:
type: string
dataset_name:
type: string
is_replica:
type: boolean
total_size:
type: integer
format: int64
base_size:
type: integer
format: int64
snapshot_size:
type: integer
format: int64
logs_size:
type: integer
format: int64
unvirtualized_size:
type: integer
format: int64
current_timeflow_unvirtualized_size:
type: integer
format: int64
timeflow_unvirtualized_size:
type: integer
format: int64
descendant_size:
type: integer
format: int64
policy_size:
type: integer
format: int64
manual_size:
type: integer
format: int64
unowned_snapshot_size:
type: integer
format: int64
ingested_size:
type: integer
format: int64
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/engineIdQueryParam'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/engineStorageCapacityDataSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns the engine storage capacity data.
content:
application/json:
schema:
type: object
title: EngineStorageCapacityDataResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/EngineStorageCapacityData'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/reporting/dataset-performance-analytics-summary/search:
post:
tags:
- Reporting
summary: Search Dataset Performance analytics summary
operationId: search_dataset_performance_analytics_summary
x-filterable:
fields:
dataset_id:
type: string
dataset_name:
type: string
dataset_type:
type: string
is_replica:
type: boolean
environment_id:
type: string
environment_name:
type: string
average_throughput_of_1_h:
type: number
format: float
average_throughput_of_6_h:
type: number
format: float
average_throughput_of_24_h:
type: number
format: float
current_throughput_of_1_h:
type: number
format: float
current_throughput_of_6_h:
type: number
format: float
current_throughput_of_24_h:
type: number
format: float
percentile:
type: number
format: float
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/engineIdQueryParamRequired'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/datasetPerformanceAnalyticsSummarySortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: Returns the dataset performance analytics data.
content:
application/json:
schema:
type: object
title: DatasetPerformanceAnalyticsSummaryResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatasetPerformanceAnalyticsSummary'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/reporting/dataset-performance-analytics:
post:
tags:
- Reporting
summary: Get Dataset Performance analytics
operationId: get_dataset_performance_analytics
requestBody:
content:
application/json:
schema:
x-body-name: dataset_performance_analytics_request
$ref: '#/components/schemas/DatasetPerformanceAnalyticsRequest'
responses:
'200':
description: Returns the Dataset Performance Analytics
content:
application/json:
schema:
type: object
title: DatasetPerformanceAnalyticsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatasetPerformanceAnalytics'
components:
schemas:
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
EngineStorageDatasetType:
type: string
description: Type of the dataset.
enum:
- VDB
- DSOURCE
- CDB
- VCDB
- HELDSPACE
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
StorageSavingsSummaryData:
properties:
dsource_id:
description: Id of the dSource.
type: string
dependant_vdbs:
description: The number of VDBs that are dependant on this dSource. This includes all VDB descendants that have this dSource as an ancestor.
type: integer
example: 200
engine_name:
description: The engine name.
type: string
minLength: 1
example: My Favorite Engine
unvirtualized_space:
description: The disk space, in bytes, that it would take to store the dSource and its descendant VDBs without Delphix, counting each of their timeflows as separate copy of the parent source data.
type: integer
format: int64
example: 109242677
current_timeflows_unvirtualized_space:
description: The disk space, in bytes, that it would take to store the dSource and its descendant VDBs without Delphix, counting only their current (active) timeflows.
type: integer
format: int64
example: 109242677
virtualized_space:
description: The actual space used by the dSource and its dependant VDBs, in bytes.
type: integer
format: int64
example: 12345678
name:
type: string
descr
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-reporting-api-openapi.yml