Delphix Connectors API

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
 

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-connectors-api-openapi.yml