Delphix Sources API

openapi: 3.2.0
info:
  title: Delphix DCT Sources 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: Sources
paths:
  /sources:
    get:
      summary: List all sources
      operationId: get_sources
      tags:
      - Sources
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/sourcesSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListSourcesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Source'
                  errors:
                    $ref: '#/components/schemas/Errors'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /sources/oracle:
    post:
      tags:
      - Sources
      summary: Create an Oracle Source
      operationId: create_oracle_source
      requestBody:
        $ref: '#/components/requestBodies/CreateOracleSourceBody'
      responses:
        '201':
          description: Oracle Source creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateOracleSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  source_id:
                    type: string
                    description: The id of the created source.
                    example: 1-ORACLE_SINGLE_CONFIG-32
  /sources/oracle/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      summary: Update an Oracle source by ID
      operationId: update_oracle_source_by_id
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/UpdateOracleSourceBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateOracleSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/{sourceId}/jdbc-check:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    post:
      tags:
      - Sources
      summary: Verify JDBC connection string for a source
      operationId: verify_source_jdbc_connection_string
      requestBody:
        $ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
      responses:
        '200':
          description: Success or Failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectivityCheckResponse'
  /sources/postgres:
    post:
      summary: Create a PostgreSQL source
      operationId: create_postgres_source
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/CreatePostgresSource'
      responses:
        '201':
          description: PostgreSQL Source creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreatePostgresSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  source_id:
                    type: string
                    description: The id of the created source.
                    example: source-1
  /sources/appdata:
    post:
      summary: Create an AppData source
      operationId: create_app_data_source
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/CreateAppDataSource'
      responses:
        '201':
          description: AppData Source creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateAppDataSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  source_id:
                    type: string
                    description: The id of the created source.
                    example: source-1
  /sources/appdata/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      summary: Update a AppData source by ID
      operationId: update_appdata_source_by_id
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/UpdateAppDataSource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateAppDataSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/postgres/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      summary: Update a PostgreSQL source by ID
      operationId: update_postgres_source_by_id
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/UpdatePostgresSource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdatePostgresSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/ase:
    post:
      summary: Create an ASE source
      operationId: create_ase_source
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/CreateAseSourceBody'
      responses:
        '201':
          description: Sybase ASE Source creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateAseSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  source_id:
                    type: string
                    description: The id of the created source.
                    example: 1-source-3
  /sources/mssql:
    post:
      summary: Create an MSSQL source
      operationId: create_mssql_source
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/CreateMssqlSourceBody'
      responses:
        '201':
          description: MSSQL Source creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateMssqlSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  source_id:
                    type: string
                    description: The id of the created source.
                    example: 1-source-3
  /sources/ase/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      summary: Update an ASE source by ID
      operationId: update_ase_source_by_id
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/UpdateAseSourceBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateAseSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/mssql/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      summary: Update an MSSQL source by ID
      operationId: update_mssql_source_by_id
      tags:
      - Sources
      requestBody:
        $ref: '#/components/requestBodies/UpdateMssqlSourceBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateMssqlSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/search:
    post:
      summary: Search for Sources
      operationId: search_sources
      tags:
      - Sources
      x-filterable:
        fields:
          id:
            type: string
          database_type:
            type: string
          name:
            type: string
          database_version:
            type: string
          environment_id:
            type: string
          environment_name:
            type: string
          data_uuid:
            type: string
          ip_address:
            type: string
          fqdn:
            type: string
          size:
            type: integer
          jdbc_connection_string:
            type: string
          plugin_version:
            type: string
          is_dsource:
            type: boolean
          namespace_id:
            type: string
          namespace_name:
            type: string
          is_replica:
            type: boolean
          recovery_model:
            type: string
          mssql_source_type:
            type: string
          appdata_source_type:
            type: string
          is_pdb:
            type: boolean
          instance_name:
            type: string
          instance_number:
            type: integer
          user:
            type: string
          environment_user_ref:
            type: string
          non_sys_user:
            type: string
          discovered:
            type: boolean
          linking_enabled:
            type: boolean
          repository:
            type: string
          cdb_type:
            type: string
          data_connection_id:
            type: string
          database_name:
            type: string
          database_unique_name:
            type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/sourcesSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchSourcesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Source'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /sources/{sourceId}:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    get:
      summary: Get a source by ID
      operationId: get_source_by_id
      tags:
      - Sources
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Source'
    delete:
      summary: Delete a source by ID
      operationId: delete_source
      tags:
      - Sources
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/{sourceId}/update:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    patch:
      deprecated: true
      summary: Update a Source
      tags:
      - Sources
      operationId: update_source_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_source_parameter
              $ref: '#/components/schemas/UpdateSourceParameters'
        description: The parameters to update a Source.
      responses:
        '200':
          description: Source update initiated.
          content:
            application/json:
              schema:
                type: object
                title: UpdateSourceResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /sources/{sourceId}/tags:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    post:
      tags:
      - Sources
      summary: Create tags for a Source
      operationId: create_source_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: vdb_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Source.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - Sources
      summary: Get tags for a Source
      operationId: get_source_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /sources/{sourceId}/staging_compatible_repositories:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    get:
      tags:
      - Sources
      summary: Returns a list of repositories that match the specified source
      operationId: get_source_compatible_repo
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: StagingCompatibleEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /sources/{sourceId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/sourceIdParam'
    post:
      tags:
      - Sources
      summary: Delete tags for a Source
      operationId: delete_source_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
components:
  schemas:
    OracleClusterNodeInstance:
      description: An oracle cluster node instance.
      type: object
      properties:
        instance_name:
          description: The name of this instance.
          type: string
        instance_number:
          type: integer
          description: The number of this instance.
        source_id:
          type: string
          description: The id of Source this instance belongs to.
    OracleListener:
      properties:
        id:
          description: Id of this listener.
          type: string
          example: 1-ORACLE_NODE_LISTENER-11
        name:
          description: Name of this listener.
          type: string
          example: my-listener
        type:
          description: Type of this listener.
          $ref: '#/components/schemas/OracleListenerTypeEnum'
          example: NODE
        protocol_addresses:
          description: The list of protocol addresses for this listener.
          type: array
          items:
            type: string
          example:
          - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567))
          - (ADDRESS=(PROTOCOL=ipc)(KEY=LISTENER))
        client_endpoints:
          description: The list of client endpoints for this listener.
          type: array
          items:
            type: string
          example:
          - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567))
        is_discovered:
          description: Whether this listener was automatically discovered or not.
          type: boolean
        host_id:
          description: Id to the host this listener is associated with.
          type: string
          example: 1-UNIX_HOST-14
    OracleService:
      properties:
        discovered:
          description: Represents whether this jdbc connection string is auto discovered or not.
          type: boolean
        jdbc_connection_string:
          description: The jdbc connection string used to connect with the database.
          type: string
          example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.230.197)(PORT=1521))(CONNECT_DATA=(UR=A)(SERVICE_NAME=VDBOMSRBBDC6C_UJG)))
    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-<id>.
          type: string
          example: User 1
        compliance_node_id:
          description: The ID of the associated compliance node, if applicable.
          type:
          - string
          - 'null'
        compliance_node_name:
          description: The name of the associated compliance node, if applicable.
          type:
          - string
          - 'null'
        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
          - 'null'
        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
      discriminator:
        propertyName: class_type
    AppDataSourceCreateParameters:
      type: object
      required:
      - name
      - repository_id
      - type
      properties:
        type:
          description: The type of source to create. Default is DIRECT.
          type: string
          enum:
          - DIRECT
          - STAGED
          default: DIRECT
        name:
          type: string
          description: The name of the source.
          minLength: 1
          maxLength: 256
          example: postgres-test
        repository_id:
          type: string
          description: The ID of the Repository onto which the source will be created.
          minLength: 1
          example: 1-APPDATA_REPOSITORY-10
        linking_enabled:
          type: boolean
          description: Whether this source should be used for linking.
          default: true
        environment_user:
          type: string
          description: The environment user reference.
          minLength: 1
          maxLength: 256
        parameters:
          description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
          type: object
          additionalProperties: true
        path:
          description: The path to the data to be synced. This should only be passed for type=DIRECT.
          type: string
          minLength: 1
          maxLength: 1024
          example: /usr/home
        environment_id:
          type: string
          description: The ID of the environment to create the source on.
          example: 7-UNIX_HOST_ENVIRONMENT-3
        engine_id:
          type: string
          description: The ID of the engine to create the source on.
          example: '1'
    MSSQLListenerTypeEnum:
      type: string
      enum:
      - MSSqlAvailabilityGroupListener
      - MSSqlFailoverClusterListener
      example: MSSqlAvailabilityGroupListener
    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
    PostgresSourceCreateParameters:
      type: object
      required:
      - name
      - repository
      properties:
        name:
          type: string
          description: The name of the source.
          minLength: 1
          maxLength: 256
          example: postgres-test
        repository_id:
          type: string
          description: The ID of the Repository onto which the source will be created.
          minLength: 1
          example: 1-APPDATA_REPOSITORY-10
        engine_id:
          type: string
          description: The ID of the engine to create the source on.
          example: '1'
        environment_id:
          type: string
          description: The ID of the environment to create the source on.
          example: 7-UNIX_HOST_ENVIRONMENT-3
    UpdateSourceParameters:
      deprecated: true
      type: object
      description: Parameters to update a Source.
      properties:
        oracle_services:
          type: array
          items:
            type: string
          description: List of jdbc connection strings which are used to connect with the database.
          example:
          - jdbc:oracle:thin:@hostname:port/service_name
          - jdbc:oracle:thin:@hostname:port:SID
    Host:
      description: A physical/virtual server.
      type: object
      properties:
        id:
          description: The entity ID of this Host.
          type: string
          minLength: 1
          maxLength: 256
          example: 3-UNIX_HOST-5
        reference:
          description: Delphix engine equivalent constant
          type: string
          example: UNIX_HOST-5
        hostname:
          description: The hostname or IP address of this host.
          type: string
          example: linux.dev.delphix.com
        os_name:
          description: The name of the OS on this host.
          type: string
          example: Linux
        os_version:
          description: The version of the OS on this host.
          type: string
          example: Red Hat Enterprise Linux Server release 7.3 (Maipo)
        distribution:
          description: The name of the OS distribution on this host.
          type: string
          example: RedHat
        memory_size:
          description: The total amount of memory on this host in bytes.
          type: integer
          format: int64
          example: 8382160896
        available:
          description: True if the host is up and a connection can be established from the engine.
          type: boolean
          example: false
        available_timestamp:
          description: The last time the available property was updated.
          type: string
          format: date-time
          example: '2022-06-02T17:49:11.457Z'
        not_available_reason:
          description: The reason why the host is not available.
          type: string
          example: Failed to connect to host
        oracle_cluster_node_reference:
          description: The reference to the associated OracleClusterNode.
          type: string
          example: ORACLE_CLUSTER_NODE-1
        oracle_cluster_node_name:
          description: The name of the associated OracleClusterNode.
          type: string
          example: my-favorite-cluster-node
        oracle_cluster_node_enabled:
          description: Whether the associated OracleClusterNode is enabled.
          type: boolean
          example: true
        oracle_cluster_node_discovered:
          description: Whether the associated OracleClusterNode was discovered.
          type: boolean
          example: true
        oracle_cluster_node_virtual_ips:
          description: The Virtual IP addresses associated with the OracleClusterNode.
          type: array
          items:
            $ref: '#/components/schemas/OracleVirtualIP'
        oracle_cluster_node_instances:
          description: The instances associated with the OracleClusterNode.
          type: array
          items:
            $ref: '#/components/schemas/OracleClusterNodeInstance'
        windows_cluster_node_reference:
          description: The reference to the associated WindowsClusterNode.
          type: string
          example: WINDOWS_CLUSTER_NODE-1
        windows_cluster_node_name:
          description: The name of the associated WindowsClusterNode.
          type: string
          example: my-favorite-cluster-node
        windows_cluster_node_discovered:
          description: Whether the associated Windows cluster node was discovered.
          type: boolean
          example: true
        nfs_addresses:
          description: The list of host/IP addresses to use for NFS export.
          type: array
          items:
            type: string
          uniqueItems: true
          example:
          - 192.168.10.2
        dsp_keystore_alias:
          description: The lowercase alias to use inside the user managed DSP keystore.
          type: string
          minLength: 1
          example: oracle-env
        dsp_keystore_path:
          description: The path to the user managed DSP keystore.
          type: string
          minLength: 1
          example: /tmp/keystore.keystore
        dsp_truststore_path:
          description: The path to the user managed DSP truststore.
          type: string
          minLength: 1
          example: /tmp/truststore.keystore
        java_home:
          description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used.
          type: string
          minLength: 1
          example: /Library/Java/JavaVirtualMachines/jdk/Contents/Home
        ssh_port:
          description: The port number used to connect to the host via SSH.
          type: integer
          example: 22
        toolkit_path:
          description: The path for the toolkit that resides on the host.
          type: string
          minLength: 1
          example: /work
        connector_port:
          description: The port that the Windows Connector connects on.
          type: integer
          example: 9100
        connector_version:
          description: The Windows Connector version that is installed on the provided host.
          type: string
          example: 1.17.0
        connector_dot_net_framework_version:
          description: The .NET Framework version used for Windows Connector Service.
          type: string
          example: '3.5'
        oracle_tde_keystores_root_path:
          description: The path to the root of the Oracle TDE keystores artifact directories.
          type: string
          minLength: 1
          example: /keystore/root/path
        oracle_tde_okv_home_path:
          description: The path to the Oracle Key Vault library installation on the database node.
          type: string
          minLength: 1
          example: /work/okv
        processor_type:
          description: The platform for the host machine.
          type: string
          example: x86_64
        timezone:
          description: The OS timezone.
          type: string
          example: America/New_York,EST-0500
        powershell_version:
          description: The PowerShell version installed on the windows target host.
          type: string
          example: 5.1.17763.134
        release:
          description: The OS release.
          type: string
          example: '6.3'
        trace_route_info:
          description: Traceroute network hops from host to Delphix Engine.
          type: string
          example: 1 <1 ms <1 ms <1 ms 10.110.232.122
        is_tde_external_key_manager_password_set:
          description: True if Oracle TDE External key Manager password is set.
          type: boolean
          example: true
    OracleSourceUpdateParameters:
      type: object
      description: Parameters to update an Oracle source.
      properties:
        oracle_services:
          type: array
          items:
            type: string
          description: List of jdbc connection strings which are used to connect with the database.
          example:
          - jdbc:oracle:thin:@hostname:port/service_name
          - jdbc:oracle:thin:@hostname:port:SID
        user:
          type: string
          description: Database user for accessing this source.
          minLength: 1
          maxLength: 30
          example: user
        passwor

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