openapi: 3.0.0 info: title: Delphix DCT Algorithms Connectors 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: Connectors paths: /connectors: get: tags: - Connectors summary: Retrieve the list of masking connectors. operationId: get_connectors parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/connectorsSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ListConnectorsResponse properties: items: type: array items: $ref: '#/components/schemas/Connector' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' post: tags: - Connectors summary: Create a Connector. operationId: create_connector requestBody: content: application/json: schema: x-body-name: connector_create_request $ref: '#/components/schemas/ConnectorCreateRequest' description: The new Connector to create required: true responses: '201': description: Created Connector. content: application/json: schema: type: object title: ConnectorCreateResponse properties: id: type: string description: The ID of the created connector. job: $ref: '#/components/schemas/Job' description: The created connector. /connectors/test: post: tags: - Connectors summary: Checks connectivity of an unsaved remote data source. operationId: test_unsaved_connector requestBody: description: The connector details to use to test. required: true content: application/json: schema: x-body-name: connector_test_request $ref: '#/components/schemas/ConnectorTestRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConnectorTestResponse' /connectors/{connectorId}: parameters: - $ref: '#/components/parameters/connectorIdParam' get: summary: Retrieve a masking Connector by ID. operationId: get_connector_by_id tags: - Connectors responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Connector' patch: summary: Update a masking Connector by ID. operationId: update_connector_by_id tags: - Connectors requestBody: content: application/json: schema: x-body-name: update_connector_parameter $ref: '#/components/schemas/ConnectorUpdateParameters' description: The new data to update a masking Connector. responses: '200': description: OK content: application/json: schema: type: object title: UpdateConnectorResponse properties: job: $ref: '#/components/schemas/Job' delete: tags: - Connectors summary: Delete a DCT managed masking connector. operationId: delete_connector responses: '200': description: OK content: application/json: schema: type: object title: ConnectorDeleteResponse properties: job: $ref: '#/components/schemas/Job' description: The completed job. /connectors/{connectorId}/driver-support-tasks: parameters: - $ref: '#/components/parameters/connectorIdParam' get: tags: - Connectors summary: Retrieve driver support tasks for a connector. operationId: get_connector_driver_support_tasks responses: '200': description: OK content: application/json: schema: type: object title: GetConnectorDriverSupportTasksResponse properties: tasks: type: array items: type: string /connectors/{connectorId}/test: post: tags: - Connectors summary: Checks connectivity of the connector operationId: test_connector parameters: - $ref: '#/components/parameters/connectorIdParam' requestBody: description: The connector details to use to test. content: application/json: schema: x-body-name: connector_test_request $ref: '#/components/schemas/ConnectorTestRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConnectorTestResponse' /connectors/{connectorId}/properties: parameters: - $ref: '#/components/parameters/connectorIdParam' get: tags: - Connectors summary: Retrieve the combined properties from jdbc-driver and the properties-file of the connector. operationId: get_connection_properties responses: '200': description: Success content: application/json: schema: type: object title: ListConnectionPropertiesResponse properties: items: type: array items: $ref: '#/components/schemas/ConnectionProperty' /connectors/{connectorId}/fetch-table-names: parameters: - $ref: '#/components/parameters/connectorIdParam' post: summary: Return the name of all tables accessible by the database user. operationId: fetch_table_names tags: - Connectors requestBody: content: application/json: schema: x-body-name: fetch_table_names_request $ref: '#/components/schemas/FetchTableNamesRequest' required: false responses: '200': description: OK content: application/json: schema: type: object title: FetchTableNamesResponse properties: items: type: array items: type: string job: $ref: '#/components/schemas/Job' description: The completed job. /connectors/{connectorId}/masking-jobs/search: parameters: - $ref: '#/components/parameters/connectorIdParam' post: tags: - Connectors x-filterable: fields: id: type: string name: type: string is_on_the_fly_masking: type: boolean last_execution_time: type: string last_execution_status: type: string creation_date: type: string tags: type: array[object] fields: key: type: string value: type: string connector_role: type: string enum: - SOURCE - TARGET summary: Search jobs that use this connector operationId: search_connector_jobs parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/jobWithConnectorSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: ListConnectorsMaskingJobsResponse properties: items: type: array items: $ref: '#/components/schemas/MaskingJobWithConnectorRole' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /connectors/{connectorId}/tags: parameters: - $ref: '#/components/parameters/connectorIdParam' post: tags: - Connectors summary: Create tags for a Connector. operationId: create_connector_tags requestBody: content: application/json: schema: x-body-name: connector_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for Connector. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' get: tags: - Connectors summary: Get tags for a Connector. operationId: get_connector_tags responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /connectors/{connectorId}/tags/delete: parameters: - $ref: '#/components/parameters/connectorIdParam' post: tags: - Connectors summary: Delete tags for a Connector. operationId: delete_connector_tag requestBody: $ref: '#/components/requestBodies/DeleteTags' required: false responses: '204': description: No Content /connectors/search: post: summary: Search for masking Connectors. operationId: search_connectors tags: - Connectors x-filterable: fields: id: type: string engine_id: type: string engine_name: type: string type: type: string platform: type: string database_type: type: string name: type: string hostname: type: string username: type: string port: type: integer auth_present: type: boolean custom_driver_name: type: string database_name: type: string instance_name: type: string jdbc: type: string schema_name: type: string sid: type: string kerberos_auth: type: boolean service_principal: type: string enable_logger: type: boolean file_type: type: string connection_mode: type: string path: type: string ssh_key: type: string user_dir_is_root: type: boolean data_connection_id: type: string account_id: type: integer account_name: type: string dct_managed: type: boolean job_orchestrator_id: type: string job_orchestrator_name: type: string owning_entity_id: type: string owning_entity_name: type: string owning_entity_type: 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/connectorsSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchConnectorsResponse properties: items: type: array items: $ref: '#/components/schemas/Connector' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' components: schemas: ConnectorTypeEnum: type: string enum: - DATABASE - FILE - MAINFRAME_DATASET example: DATABASE 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 VirtualizationTaskEvent: deprecated: true properties: message_details: type: string Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 MaskingJobWithConnectorRole: description: A simplified job object combined with a connector ID and the connector's role in that job type: object properties: id: description: The Job entity ID. type: string example: job-123 name: description: The name of this Masking Job. type: string example: My favorite MaskingJob creation_date: description: The date this MaskingJob was created. type: string format: date-time example: '2022-11-30T08:51:34.148000+00:00' is_on_the_fly_masking: description: Whether the job is an on-the-fly masking job type: boolean last_execution_time: description: The start time of the most recent execution of this job, if available type: string format: date-time last_execution_status: $ref: '#/components/schemas/ExecutionStatus' tags: type: array items: $ref: '#/components/schemas/Tag' connector_id: description: The ID of the connector this job is related to type: string nullable: true connector_role: description: The role of the connector in the job type: string enum: - SOURCE - TARGET nullable: false 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 JobTaskEvent: properties: message_details: type: string Connector: description: Connectors are the way users define the data sources to which the Masking Engine should connect. type: object properties: id: description: The Connector entity ID. type: string example: 1-database-123 name: description: The Connector name. type: string example: connector-name engine_id: description: The id of the Compliance Engine that this Connector belongs to. type: string example: '123' engine_name: description: The name of the Compliance Engine that this Connector belongs to. type: string example: my-compliance-engine-1 type: description: The type of Connector. One of Database, File, or Mainframe. $ref: '#/components/schemas/ConnectorTypeEnum' hostname: description: The network hostname or IP address of the database server. type: string example: database_server.mycompany.co port: description: The TCP port of the server. type: integer format: int32 minimum: 1 maximum: 65535 example: 9100 username: description: The username this Connector will use to connect to the database. type: string password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the database. type: string auth_present: description: Whether this connector has authentication credentials set type: boolean database_type: description: The database variant, such as Oracle or MSSQL Server type: string enum: - AURORA_POSTGRES - DB2 - DB2_ISERIES - DB2_MAINFRAME - EXTENDED - GENERIC - MARIADB - MSSQL - MYSQL - ORACLE - POSTGRES - RDS_POSTGRES - SYBASE - YUGABYTEDB_POSTGRES - COCKROACHDB_POSTGRES example: ORACLE custom_driver_name: description: The name of the custom JDBC driver for this connector type: string database_name: description: The database name for this connector type: string instance_name: description: The instance name for this connector type: string jdbc: description: The jdbc URL for this connector type: string schema_name: description: The schema name for this connector type: string sid: description: The SID value for this connector. This field is specific to Oracle database connectors type: string kerberos_auth: description: Whether kerberos authentication is enabled for this connector type: boolean service_principal: description: The service principal to use for kerberos authentication type: string enable_logger: description: Whether the logger is enable for this connector type: boolean file_type: description: The type of file this connector is configured to access. Immutable after creation. type: string enum: - DELIMITED - FIXED_WIDTH - XML - JSON - PARQUET example: DELIMITED connection_mode: description: The connection mode for file connectors. type: string enum: - FTP - FTPS - SFTP - MOUNT - AWS_S3 - S3_COMPATIBLE - AZURE_BLOB_STORAGE example: SFTP path: description: The path on the remote server for file connections. type: string ssh_key: description: 'The DCT SSH key UUID (from POST /ssh-keys) to use for SFTP connections. DCT pushes the key bytes to the engine filesystem before connector sync. ' type: string user_dir_is_root: description: For SFTP connections only, whether the user dir is set to root. type: boolean default: false mount_information_id: description: The DCT UUID of the mount information record (MOUNT mode only). type: string bucket_name: description: The storage bucket name (AWS_S3 and S3_COMPATIBLE modes). type: string region: description: The cloud storage region (AWS_S3 and S3_COMPATIBLE modes). type: string access_key: x-dct-toolkit-credential-field: true description: The access key for cloud storage authentication (AWS and AZURE modes). type: string secret_key: x-dct-toolkit-credential-field: true description: The secret key for AWS storage authentication. type: string auth_type: description: 'The authentication type for cloud storage. For AWS_S3: AWS_ROLE or AWS_SECRET. For AZURE_BLOB_STORAGE: AZURE_MANAGED_IDENTITY or AZURE_SECRET. ' type: string enum: - AWS_ROLE - AWS_SECRET - AZURE_MANAGED_IDENTITY - AZURE_SECRET prefix: description: The key prefix for cloud storage (AWS and AZURE modes). type: string delimiter: description: The key delimiter for cloud storage (AWS and AZURE modes). type: string service_endpoint: description: The service endpoint URL for S3_COMPATIBLE mode. type: string azure_account_name: description: The Azure storage account name (AZURE_BLOB_STORAGE mode). type: string azure_container_name: description: The Azure blob container name (AZURE_BLOB_STORAGE mode). type: string is_mvs_storage: description: Whether the mainframe connector uses MVS storage. Read-only. type: boolean readOnly: true password_vault_auth: description: Whether the connector uses password vault authentication. Read-only. type: boolean readOnly: true credential_path_id: description: The DCT UUID of the credential path record for password vault auth. type: string platform: description: This database or file connection type associated with the connector type: string example: ORACLE data_connection_id: description: The ID of the associated DataConnection. type: string example: data-connection-1 account_id: description: The ID of the account who created this connector. type: integer format: int64 readOnly: true example: 1 account_name: description: The account name of the DCT user who created this connector. type: string readOnly: true example: John Doe dct_managed: description: Whether this connector is managed by DCT or not. type: boolean readOnly: true job_orchestrator_id: description: The ID of the job orchestrator that is associated with this connector. type: string job_orchestrator_name: description: The name of the job orchestrator that is associated with this connector. type: string file_reference_id: description: The reference uri/id of the connection-properties file used by the connector. type: string owning_entity_id: description: The ID of the owning entity, if any. type: string readOnly: true owning_entity_name: description: The name of the owning entity, if any. type: string readOnly: true owning_entity_type: description: The type of the owning entity, if any. type: string enum: - PAAS_INSTANCE readOnly: true tags: type: array items: $ref: '#/components/schemas/Tag' example: id: 1-database-123 name: connector-name engine_id: 123 type: DATABASE hostname: database_server.example.com database_type: POSTGRES schema_name: public database_name: public port: 5432 username: user-123 kerberos_auth: false service_principal: krbuser 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' ConnectorUpdateParameters: x-jackson-optional-nullable-helpers: true description: Parameters used to update a Masking Connector. type: object properties: name: description: The Connector name. type: string hostname: description: The network hostname or IP address of the database server. type: string nullable: true x-is-jackson-optional-nullable: true port: description: The TCP port of the server. type: integer format: int32 nullable: true minimum: 1 maximum: 65535 x-is-jackson-optional-nullable: true username: description: The username this Connector will use to connect to the database. type: string password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the database. type: string jdbc_url: description: The jdbc URL for this connector. type: string nullable: true x-is-jackson-optional-nullable: true schema_name: description: The schema name for this connector type: string database_name: description: The name of the database to connect to. This field is not valid for database types 'ORACLE'. type: string nullable: true x-is-jackson-optional-nullable: true instance_name: description: The name of the database instance. Only used for database type 'MSSQL'. type: string nullable: true x-is-jackson-optional-nullable: true sid: description: The SID value for this connector. This field is specific to Oracle database connectors type: string nullable: true x-is-jackson-optional-nullable: true job_orchestrator_id: type: string minLength: 1 description: The ID or name of the job orchestrator that is associated with this connector. file_reference_id: type: string description: The reference ID of the connection-properties file to be used for the connector. nullable: true x-is-jackson-optional-nullable: true kerberos_auth: description: Whether to use kerberos to authenticate connections. When kerberos_auth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on every compliance node in the connector's job orchestrator. type: boolean service_principal: description: The service principal to use for kerberos authentication. This property is exclusive to Sybase connectors using Kerberos. type: string nullable: true x-is-jackson-optional-nullable: true connection_mode: description: The connection mode for file connectors. type: string enum: - FTP - FTPS - SFTP - MOUNT - AWS_S3 - S3_COMPATIBLE - AZURE_BLOB_STORAGE nullable: true x-is-jackson-optional-nullable: true path: description: The path on the remote server for file connections. type: string nullable: true x-is-jackson-optional-nullable: true ssh_key: description: 'The DCT SSH key UUID (from POST /ssh-keys) to use for SFTP connections. DCT pushes the key bytes to the engine filesystem before connector sync. ' type: string nullable: true x-is-jackson-optional-nullable: true user_dir_is_root: description: For SFTP connections only, whether the user dir is set to root. type: boolean nullable: true x-is-jackson-optional-nullable: true mount_information_id: description: The DCT UUID of the mount information record (MOUNT mode only). type: string nullable: true x-is-jackson-optional-nullable: true bucket_name: description: The storage bucket name (AWS_S3 and S3_COMPATIBLE modes). type: string nullable: true x-is-jackson-optional-nullable: true region: description: The cloud storage region (AWS_S3 and S3_COMPATIBLE modes). type: string nullable: true x-is-jackson-optional-nullable: true access_key: x-dct-toolkit-credential-field: true description: The access key for cloud storage authentication (AWS and AZURE modes). type: string nullable: true x-is-jackson-optional-nullable: true secret_key: x-dct-toolkit-credential-field: true description: The secret key for AWS storage authentication. type: string nullable: true x-is-jackson-optional-nullable: true auth_type: description: 'The authentication type for cloud storage. For AWS_S3: AWS_ROLE or AWS_SECRET. For AZURE_BLOB_STORAGE: AZURE_MANAGED_IDENTITY or AZURE_SECRET. ' type: string enum: - AWS_ROLE - AWS_SECRET - AZURE_MANAGED_IDENTITY - AZURE_SECRET nullable: true x-is-jackson-optional-nullable: true prefix: description: The key prefix for cloud storage (AWS and AZURE modes). type: string nullable: true x-is-jackson-optional-nullable: true delimiter: description: The key delimiter for cloud storage (AWS and AZURE modes). type: string nullable: true x-is-jackson-optional-nullable: true service_endpoint: description: The service endpoint URL for S3_COMPATIBLE mode. type: string nullable: true x-is-jackson-optional-nullable: true azure_account_name: description: The Azure storage account name (AZURE_BLOB_STORAGE mode). type: string nullable: true x-is-jackson-optional-nullable: true azure_container_name: description: The Azure blob container name (AZURE_BLOB_STORAGE mode). type: string nullable: true x-is-jackson-optional-nullable: true credential_path_id: description: The DCT UUID of the credential path record for password vault auth. type: string nullable: true x-is-jackson-optional-nullable: true example: name: connector-name hostname: database_server.mycompany.co port: 4322 username: user-123 password: password123 schema_name: public sid: ORCL job_orchestrator_id: 1-job-orchestrator-123 kerberos_auth: false service_principal: krbuser 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 ExecutionStatus: description: The status of a masking or discovery job. type: string enum: - PENDING - QUEUED - RUNNING - CANCELLED - FAILED - SUCCEEDED - WARNING - WAITING example: RUNNING ConnectorTestResponse: title: ConnectorTestResponse type: object description: The result of the masking connector test. required: - status - message properties: status: description: Connection status, SUCCEEDED or FAILED type: string enum: - SUCCEEDED - FAILED example: SUCCEEDED message: description: A message describing the result of the masking connector test. type: string example: Connection Succeeded job: $ref: '#/components/schemas/Job' description: The tested connector job. 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" ConnectorCreateRequest: x-jackson-optional-nullable-helpers: true description: Request body to create a Connector. type: object required: - name - type properties: name: description: The Connector name. type: string example: connector-name type: description: The type of Connector. Currently supports Database only. $ref: '#/components/schemas/ConnectorTypeEnum' hostname: description: The network hostname or IP address of the database server. type: string example: database_server.mycompany.co port: description: The TCP port of the server. type: integer format: int32 minimum: 1 maximum: 65535 example: 9100 username: description: The username this Connector will use to connect to the database. type: string password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the database. type: string database_type: description: The database variant. Currently supports [DB2, DB2_ISERIES, DB2_MAINFRAME, ORACLE, MSSQL, MYSQL, MARIADB, POSTGRES, AURORA_POSTGRES, COCKROACHDB_POSTGRES, RDS_POSTGRES, YUGABYTEDB_POSTGRES, SYBASE]. type: string enum: - DB2 - DB2_ISERIES - DB2_MAINFRAME - ORACLE - MSSQL - MYSQL - MARIADB - POSTGRES - AURORA_POSTGRES - COCKROACHDB_POSTGRES - RDS_POSTGRES - YUGABYTEDB_POSTGRES - SYBASE example: ORACLE file_type: description: The type of file this connector is configured to access. Immutable after creation. type: string enum: - DELIMITED - FIXED_WIDTH - XML - JSON - PARQUET example: DELIMITED connection_mode: description: The connection mode for file connectors. type: string enum: - FTP - FTPS - SFTP - MOUNT - AWS_S3 - S3_COMPATIBLE - AZURE_BLOB_STORAGE example: SFTP path: description: The path on the remote server for file connections. type: string ssh_key: description: 'The DCT SSH key UUID (from POST /ssh-keys) to use for SFTP connections. DCT pushes the key bytes to the engine filesystem before connector sync. ' type: string user_dir_is_root: description: For SFTP connections only, whether the user dir is set to root. type: boolean default: false mount_information_id: description: The DCT UUID of the mount information record (MOUNT mode only). type: string bucket_name: description: The storage bucket name (AWS_S3 and S3_COMPATIBLE modes). type: string region: description: The cloud storage region (AWS_S3 and S3_COMPATIBLE modes). type: string access_key: x-dct-toolkit-credential-field: true description: The access key for cloud storage authentication (AWS and AZURE modes). type: string secret_key: x-dct-toolkit-credential-field: true description: The secret key for AWS storage authentication. type: string auth_type: description: 'The authentication type for cloud storage. For AWS_S3: AWS_ROLE or AWS_SECRET. For AZURE_BLOB_STORAGE: AZURE_MANAGED_IDENTITY or AZURE_SECRET. ' type: string enum: - AWS_ROLE - AWS_SECRET - AZURE_MANAGED_IDENTITY - AZURE_SECRET prefix: description: The key prefix for cloud storage (AWS and AZURE modes). type: string delimiter: description: The key delimiter for cloud storage (AWS and AZURE modes). type: string service_endpoint: description: The service endpoint URL for S3_COMPATIBLE mode. type: string azure_account_name: description: The Azure storage account name (AZURE_BLOB_STORAGE mode). type: string azure_container_name: description: The Azure blob container name (AZURE_BLOB_STORAGE mode). type: string credential_path_id: description: The DCT UUID of the credential path record for password vault auth. type: string jdbc_url: description: The jdbc URL for this connector type: string schema_name: description: The schema name for this connector type: string database_name: description: The name of the database to connect to. This field is not valid for database types 'ORACLE'. type: string nullable: true x-is-jackson-optional-nullable: true instance_name: description: The name of the database instance. Only used for database type 'MSSQL'. type: string nullable: true x-is-jackson-optional-nullable: true sid: description: The SID value for this connector. This field is specific to Oracle database connectors type: string nullable: true x-is-jackson-optional-nullable: true tags: type: array items: $ref: '#/components/schemas/Tag' make_current_account_owner: type: boolean default: true description: Whether the account creating this connector must be configured as owner of it. job_orchestrator_id: type: string minLength: 1 description: The ID or name of the job orchestrator that is associated with this connector. file_reference_id: type: string description: The reference ID of the connection-properties file to be used for the connector. kerberos_auth: description: Whether to use kerberos to authenticate connections. When kerberos_auth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on every compliance node in the connector's job orchestrator. type: boolean default: false service_principal: description: The service principal to use for kerberos authentication. This property is exclusive to Sybase connectors using Kerberos. type: string owning_entity_id: description: The ID of the owning entity. When set, credentials and job orchestrator are retrieved from the entity. type: string owning_entity_type: description: The type of the owning entity. Required when owning_entity_id is set. type: string enum: - PAAS_INSTANCE example: type: DATABASE database_type: POSTGRES name: connector-name hostname: database_server.example.com port: 5432 username: user-123 password: '******' schema_name: public database_name: public sid: ORCL jdbc_url: jdbc:oracle:thin:@//localhost:1521/ORCL job_orchestrator_id: 1-job-orchestrator-123 file_reference_id: delphix-file://upload/f_92e8e86ec67b4559a4b002629c6c943d/companies.properties kerberos_auth: false service_principal: krbuser 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 ConnectorTestRequest: x-jackson-optional-nullable-helpers: true title: ConnectorTestRequest type: object description: The details of the connector to be tested. properties: database_type: description: The database variant. Currently supports [DB2, DB2_ISERIES, DB2_MAINFRAME, ORACLE, MSSQL, MYSQL, MARIADB, POSTGRES, AURORA_POSTGRES, COCKROACHDB_POSTGRES, RDS_POSTGRES, YUGABYTEDB_POSTGRES, SYBASE]. type: string enum: - DB2 - DB2_ISERIES - DB2_MAINFRAME - ORACLE - MSSQL - MYSQL - MARIADB - POSTGRES - AURORA_POSTGRES - COCKROACHDB_POSTGRES - RDS_POSTGRES - YUGABYTEDB_POSTGRES - SYBASE example: ORACLE nullable: true x-is-jackson-optional-nullable: true hostname: description: The network hostname or IP address of the database server. type: string example: database_server.mycompany.co nullable: true x-is-jackson-optional-nullable: true port: description: The TCP port of the server. type: integer format: int32 minimum: 1 maximum: 65535 example: 9100 nullable: true x-is-jackson-optional-nullable: true username: description: The username this Connector will use to connect to the database. type: string example: my_username password: x-dct-toolkit-credential-field: true description: The password this Connector will use to connect to the database. type: string example: my_password jdbc_url: description: The jdbc URL for this connector type: string example: jdbc:oracle:thin:@//localhost:1521/ORCL nullable: true x-is-jackson-optional-nullable: true schema_name: description: The schema name for this connector type: string example: public sid: description: The SID value for this connector. This field is specific to Oracle database connectors type: string example: ORCL nullable: true x-is-jackson-optional-nullable: true database_name: description: The name of the database to connect to. This field is not valid for database types 'ORACLE'. type: string example: my_database nullable: true x-is-jackson-optional-nullable: true instance_name: description: The name of the database instance. Only used for database type 'MSSQL'. type: string example: SQL2016 nullable: true x-is-jackson-optional-nullable: true job_orchestrator_id: description: The ID or name of the job orchestrator that is associated with this connector. type: string file_reference_id: description: The reference uri/id of the connection-properties file used by the connector. type: string nullable: true x-is-jackson-optional-nullable: true kerberos_auth: description: Whether to use kerberos to authenticate connections. When kerberos_auth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on every compliance node in the connector's job orchestrator. type: boolean service_principal: description: The service principal to use for kerberos authentication. This property is exclusive to Sybase connectors using Kerberos. type: string nullable: true x-is-jackson-optional-nullable: true owning_entity_id: description: The ID of the owning entity. When set, credentials and job orchestrator are retrieved from the entity. type: string owning_entity_type: description: The type of the owning entity. Required when owning_entity_id is set. type: string enum: - PAAS_INSTANCE TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' FetchTableNamesRequest: description: Optional parameters used when fetching table names. type: object properties: rule_set_id: description: If present fetches only tables names that aren't part of the given rule set. type: string 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 ConnectionProperty: description: Connection property. type: object properties: name: description: The property name. type: string example: oracle.jdbc.LoginTimeout value: description: The property value type: string example: '30' description: description: The property description. type: string example: Login timeout in seconds edited: description: Whether this property has been set through connection properties file. type: boolean example: true parameters: connectorsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies a descending order. example: id required: false schema: type: string enum: - id - -id - engine_id - -engine_id - engine_name - -engine_name - type - -type - database_type - -database_type - platform - -platform - name - -name - hostname - -hostname - username - -username - port - -port - auth_present - -auth_present - custom_driver_name - -custom_driver_name - database_name - -database_name - instance_name - -instance_name - jdbc - -jdbc - schema_name - -schema_name - sid - -sid - kerberos_auth - -kerberos_auth - service_principal - -service_principal - enable_logger - -enable_logger - file_type - -file_type - connection_mode - -connection_mode - path - -path - ssh_key - -ssh_key - user_dir_is_root - -user_dir_is_root - data_connection_id - -data_connection_id - account_id - -account_id - account_name - -account_name - dct_managed - -dct_managed - job_orchestrator_id - -job_orchestrator_id - job_orchestrator_name - -job_orchestrator_name - mount_information_id - -mount_information_id - credential_path_id - -credential_path_id nullable: true example: name 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 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 jobWithConnectorSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies a descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - connector_role - -connector_role - is_on_the_fly_masking - -is_on_the_fly_masking - last_execution_time - -last_execution_time - last_execution_status - -last_execution_status - creation_date - -creation_date nullable: true example: name connectorIdParam: in: path name: connectorId schema: type: string minLength: 1 required: true description: The ID of the Connector. 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