openapi: 3.0.0 info: title: Delphix DCT Algorithms HyperscaleObjects 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: HyperscaleObjects paths: /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' /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: object title: SearchHyperscaleDatasetsResponse properties: items: type: array items: $ref: '#/components/schemas/HyperscaleDataset' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' 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 HyperscaleMountPoint: title: HyperscaleMountPoint type: object description: A Mount Point for the Hyperscale instance to write to a staging area and engines to read from. required: - hyperscale_instance_id properties: id: description: The ID of the Hyperscale Mount Point. type: string readOnly: true hyperscale_instance_id: description: The ID of the Hyperscale instance of this Mount Point. type: string name: description: Name of the mount, unique for a hyperscale instance. This name will be used as a directory name by the Hyperscale instance. type: string hostname: description: The host name of the server. type: string mount_path: description: The path to the directory on the filesystem to mount. type: string mount_type: description: The type of mount filesystem. Enum having values- CIFS, NFS3, NFS4. type: string enum: - CIFS - NFS3 - NFS4 options: type: string description: The options for mount. The endpoint will return all default options and user specified options. staging_storage_type: description: The type of staging storage. type: string enum: - MOUNT - AWS_S3 - AZURE_BLOB_STORAGE auth_mechanism: description: The authentication mechanism for AWS_S3 storage. type: string enum: - AWS_ROLE - AWS_SECRET aws_bucket_name: type: string description: The aws bucket name for AWS_S3 storage. aws_bucket_region: type: string description: The aws bucket region for AWS_S3 storage. aws_bucket_prefix: type: string description: The aws bucket prefix for AWS_S3 storage. aws_bucket_delimiter: type: string description: The aws bucket delimiter for AWS_S3 storage. blob_auth_type: description: The authentication type for Azure blob storage. type: string enum: - AZURE_SECRET - AZURE_MANAGED_IDENTITY blob_account_name: type: string description: The storage account name for Azure blob storage. blob_container_name: type: string description: The blob container name for Azure blob storage. blob_container_prefix: type: string description: The blob container prefix for Azure blob storage. blob_container_delimiter: type: string description: The blob container delimiter for Azure blob storage. VirtualizationTaskEvent: deprecated: true properties: message_details: type: string HyperscaleConnectorUpdateParameters: title: HyperscaleConnectorUpdateParameters type: object description: The updatable properties of a Hyperscale Connector. properties: name: type: string source_username: description: The username this Connector will use to connect to the source database. type: string source_password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the source database. type: string source_jdbc_url: description: The JDBC URL used to connect to the source database. type: string source_mongo_url: description: The MongoDB URL used to connect to the source database. type: string example: mongodb://host:27017 source_filesystem_path: description: The path on the filesystem where source files must be read (Delimited files Only). type: string source_connection_properties: additionalProperties: type: string target_username: description: The username this Connector will use to connect to the target database. type: string target_password: x-dct-toolkit-credential-field: true description: The username this Connector will use to connect to the target database. type: string target_jdbc_url: description: The JDBC URL used to connect to the target database. type: string target_mongo_url: description: The MongoDB URL used to connect to the target database. type: string example: mongodb://host:27017 target_filesystem_path: description: The path on the filesystem where target files must be written (Delimited files Only). type: string target_connection_properties: additionalProperties: type: string Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 PaginatedResponseMetadata: type: object properties: prev_cursor: description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string next_cursor: description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string total: description: The total number of results. This value may not be provided. type: integer format: int_64 ValidateHyperscaleMountPointResponse: title: ValidateHyperscaleMountPointResponse type: object description: Mount File system permissions validation. properties: isValid: description: The flag to validate whether a file mount is valid. type: boolean default: false example: isValid: true JobTaskEvent: properties: message_details: type: string HyperscaleConnector: title: HyperscaleConnector type: object description: A Hyperscale connector to read/write data from/to a datasource. properties: id: description: The ID of the Hyperscale Connector. type: string readOnly: true hyperscale_instance_id: description: The ID of the Hyperscale instance of this Connector. type: string data_type: $ref: '#/components/schemas/HyperscaleDataTypeEnum' name: type: string source_username: description: The username this Connector will use to connect to the source database. type: string source_password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the source database. type: string source_jdbc_url: description: The JDBC URL used to connect to the source database. type: string source_mongo_url: description: The MongoDB URL used to connect to the source database. type: string example: mongodb://host:27017 source_filesystem_path: description: The path on the filesystem where source files must be read (Delimited files Only). type: string source_connection_properties: additionalProperties: type: string target_username: description: The username this Connector will use to connect to the target database. type: string target_password: x-dct-toolkit-credential-field: true description: The username this Connector will use to connect to the target database. type: string target_jdbc_url: description: The JDBC URL used to connect to the target database. type: string target_mongo_url: description: The MongoDB URL used to connect to the target database. type: string example: mongodb://host:27017 target_filesystem_path: description: The path on the filesystem where target files must be written (Delimited files Only). type: string target_connection_properties: additionalProperties: type: string tags: type: array items: $ref: '#/components/schemas/Tag' DeleteTag: type: object 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 tags: description: List of tags to be deleted type: array minItems: 1 maxItems: 1000 uniqueItems: true items: $ref: '#/components/schemas/Tag' JobTask: properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/JobTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED TagsRequest: type: object required: - tags properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 1000 uniqueItems: true SearchBody: description: Search body. type: object properties: filter_expression: type: string minLength: 5 maxLength: 50000 example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku" HyperscaleDataset: title: HyperscaleDataset type: object description: A Hyperscale Dataset. properties: id: description: The ID of the Hyperscale Dataset. type: string hyperscale_instance_id: description: The ID of the Hyperscale instance of this Dataset. type: string data_type: $ref: '#/components/schemas/HyperscaleDataTypeEnum' mount_point_id: description: The Id of the Hyperscale Mount Point used for this Dataset. type: string connector_id: description: Id the Hyperscale Connector used to read sensitive data and write masked data. type: string tags: type: array items: $ref: '#/components/schemas/Tag' VirtualizationTask: deprecated: true properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/VirtualizationTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED HyperscaleConnectorCreateParameters: title: HyperscaleConnectorCreateParameters type: object description: Parameters to create a Hyperscale Connector. properties: hyperscale_instance_id: description: The ID of the Hyperscale instance of this Connector. type: string data_type: $ref: '#/components/schemas/HyperscaleDataTypeEnum' name: type: string source_username: description: The username this Connector will use to connect to the source database. type: string source_password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the source database. type: string source_jdbc_url: description: The JDBC URL used to connect to the source database. type: string source_mongo_url: description: The MongoDB URL used to connect to the source database. type: string example: mongodb://host:27017 source_filesystem_path: description: The path on the filesystem where source files must be read (Delimited files Only). type: string source_connection_properties: additionalProperties: type: string target_username: description: The username this Connector will use to connect to the target database. type: string target_password: x-dct-toolkit-credential-field: true description: The username this Connector will use to connect to the target database. type: string target_jdbc_url: description: The JDBC URL used to connect to the target database. type: string target_mongo_url: description: The MongoDB URL used to connect to the target database. type: string example: mongodb://host:27017 target_filesystem_path: description: The path on the filesystem where target files must be written (Delimited files Only). type: string target_connection_properties: additionalProperties: type: string tags: type: array items: $ref: '#/components/schemas/Tag' make_current_account_owner: type: boolean default: true description: Whether the account creating this Hyperscale Connector must be configured as owner of it. TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' HyperscaleDatasetTableOrFileUpdateParameters: title: HyperscaleDatasetTableOrFile type: object description: The updatable properties of a table or file which is part of a hyperscale dataset. properties: filter_key: description: The unique database column field to filter the source data. Set this property to an empty string to clear the value. type: string column_array_rows: description: The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. type: integer format: int64 unload_split: description: The number of unloaded files to be generated from the source database. type: integer format: int64 stream_size: description: Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. type: integer format: int64 end_of_record: description: The end of line character. Support values are \n, \r and \r\n (Delimited files only). type: string delimiter: description: The single character length delimiter used in source files (Delimited files only). type: string enclosure: description: The single character length quote character used in the source files (Delimited files only). type: string enclosure_escape_character: description: The escape character used to escape quote characters (Delimited files only). type: string escape_enclosure_escape_character: description: Whether to escape the enclosure escape character (Delimited files only). type: boolean has_headers: description: Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking. type: boolean unique_source_files_identifier: description: This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile. type: string source_files: description: List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line. type: array items: type: string perform_join: description: Whether the split files must be joined (Delimited files only). type: boolean HyperscaleDatasetUpdateParameters: title: HyperscaleDatasetUpdateParameters type: object description: The updatable properties of a Hyperscale Dataset. properties: mount_point_id: description: The Id of the Hyperscale Mount Point used for this Dataset. type: string connector_id: description: Id the Hyperscale Connector used to read sensitive data and write masked data. type: string HyperscaleMountPointUpdateParameters: title: HyperscaleMountPointUpdateParameters type: object description: The updatable properties of a Hyperscale Mount Point. properties: name: description: Name of the mount, unique for a hyperscale instance. type: string hostname: description: The host name of the server. type: string mount_path: description: The path to the directory on the filesystem to mount. type: string mount_type: description: The type of filesystem. type: string enum: - CIFS - NFS3 - NFS4 options: type: string description: The mount options. HyperscaleDataTypeEnum: type: string description: The data type designation for the hyperscale deployment. enum: - ORACLE - MSSQL - DELIMITED_FILES - MONGO_DB example: ORACLE Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: type: string description: The ID of the associated compliance node, if applicable. nullable: true compliance_node_name: type: string description: The name of the associated compliance node, if applicable. nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object HyperscaleDatasetTableOrFile: title: HyperscaleDatasetTableOrFile type: object description: A table or file which is part of a hyperscale dataset. properties: id: description: The ID of the Hyperscale Dataset table or file. type: string schema_name: type: string description: Name of the table schema (Oracle/MSSql only). table_name: type: string description: Name of the table (Oracle/MSSql only). collection_name: type: string description: Name of the collection (MongoDB only). database_name: type: string description: Name of the database (MongoDB only). filter_key: description: The unique database column field to filter the source data. type: string column_array_rows: description: The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. type: integer format: int64 unload_split: description: The number of unloaded files to be generated from the source database. type: integer format: int64 stream_size: description: Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. type: integer format: int64 end_of_record: description: The end of line character. Support values are \n, \r and \r\n (Delimited files only). type: string delimiter: description: The single character length delimiter used in source files (Delimited files only). type: string enclosure: description: The single character length quote character used in the source files (Delimited files only). type: string enclosure_escape_character: description: The escape character used to escape quote characters (Delimited files only). type: string escape_enclosure_escape_character: description: Whether to escape the enclosure escape character (Delimited files only). type: boolean has_headers: description: Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking. type: boolean unique_source_files_identifier: description: This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile. type: string source_files: description: List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line. type: array items: type: string perform_join: description: Whether the split files must be joined (Delimited files only). type: boolean masking_inventory: type: array description: DataSet information for masking inventory. items: type: object title: HyperscaleColumnOrField properties: field_name: description: Name of the field. type: string domain_name: description: The name of the domain assigned to this field. type: string algorithm_name: description: The name of the algorithm assigned to this field. type: string date_format: description: The format of the date assigned to this field. type: string algorithm_field_name: description: The name of the algorithm field that is associated with this algorithm. type: string algorithm_group_no: description: The group number of the algorithm to identify a set of columns associated with one instance of algorithm. type: integer format: int64 parameters: hyperscaleDatasetIdParam: in: path name: hyperscaleDatasetId required: true schema: type: string minLength: 1 description: The ID of the Hyperscale Dataset. hyperscaleMountPointsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - hostname - -hostname - mount_type - -mount_type - options - -options - mount_path - -mount_path - staging_storage_type - -staging_storage_type - auth_mechanism - -auth_mechanism - aws_bucket_name - -aws_bucket_name - aws_bucket_region - -aws_bucket_region - aws_bucket_prefix - -aws_bucket_prefix - aws_bucket_delimiter - -aws_bucket_delimiter - blob_auth_type - -blob_auth_type - blob_account_name - -blob_account_name - blob_container_name - -blob_container_name - blob_container_prefix - -blob_container_prefix - blob_container_delimiter - -blob_container_delimiter - hyperscale_instance_id - -hyperscale_instance_id nullable: true example: name hyperscaleDatasetTablesOrFilesSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - schema_name - -schema_name - table_name - -table_name - database_name - -database_name - collection_name - -collection_name - filter_key - -filter_key - column_array_rows - -column_array_rows - unload_split - -unload_split - stream_size - -stream_size nullable: true example: table_name hyperscaleConnectorIdParam: in: path name: hyperscaleConnectorId required: true schema: type: string minLength: 1 description: The ID of the Hyperscale Connector. limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 hyperscaleDatasetsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - hyperscale_instance_id - -hyperscale_instance_id - data_type - -data_type - connector_id - -connector_id - mount_point_id - -mount_point_id nullable: true example: id hyperscaleConnectorsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - hyperscale_instance_id - -hyperscale_instance_id - data_type - -data_type - source_username - -source_username - source_jdbc_url - -source_jdbc_url - source_mongo_url - -source_mongo_url - target_username - -target_username - target_jdbc_url - -target_jdbc_url - target_mongo_url - -target_mongo_url nullable: true example: source_username cursor: name: cursor in: query description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. schema: type: string minLength: 1 maxLength: 4096 hyperscaleDatasetTableOrFileIdParam: in: path name: hyperscaleDatasetTableOrFileId required: true schema: type: string minLength: 1 description: The ID of the Hyperscale Dataset table or file. hyperscaleMountPointIdParam: in: path name: hyperscaleMountPointId required: true schema: type: string minLength: 1 description: The ID of the Hyperscale Mount Point. requestBodies: SearchBody: x-skip-codegen-attr: description description: 'A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH ''12''` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS ''foo'') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization