Delphix Environments API

openapi: 3.0.0
info:
  title: Delphix DCT Algorithms Environments 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: Environments
paths:
  /environments:
    get:
      summary: List all environments.
      operationId: get_environments
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/envSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
                  errors:
                    $ref: '#/components/schemas/Errors'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - Environments
      summary: Create an environment.
      operationId: create_environment
      requestBody:
        $ref: '#/components/requestBodies/CreateEnvironment'
      responses:
        '201':
          description: Environment creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  environment_id:
                    type: string
                    description: The id of environment created.
                    example: host-environment-1
  /environments/compatible_repositories_by_snapshot:
    post:
      summary: Get compatible repositories corresponding to the snapshot.
      tags:
      - Environments
      operationId: compatible_repositories_by_snapshot
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: snapshot_compatible_repositories_parameter
              $ref: '#/components/schemas/SnapshotCompatibleRepositoryRequest'
        description: The request to get compatible repositories for provisioning a new VDB by snapshot.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SnapshotCompatibleEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /environments/compatible_repositories_by_timestamp:
    post:
      summary: Get compatible repositories corresponding to the timestamp.
      tags:
      - Environments
      operationId: compatible_repositories_by_timestamp
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: timestamp_compatible_repositories_parameter
              $ref: '#/components/schemas/TimestampCompatibleRepositoryRequest'
        description: The request to get compatible repositories for provisioning a new VDB by timestamp.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: TimestampCompatibleEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /environments/compatible_repositories_from_bookmark:
    post:
      summary: Get compatible repositories corresponding to the bookmark.
      tags:
      - Environments
      operationId: compatible_repositories_from_bookmark
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: bookmark_compatible_repositories_parameter
              $ref: '#/components/schemas/BookmarkCompatibleRepositoryRequest'
        description: The request to get compatible repositories for provisioning a new VDB by bookmark.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: BookmarkCompatibleEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /environments/compatible_repositories_by_location:
    post:
      summary: Get compatible repositories corresponding to the location.
      tags:
      - Environments
      operationId: compatible_repositories_by_location
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: location_compatible_repositories_parameter
              $ref: '#/components/schemas/LocationCompatibleRepositoryRequest'
        description: The request to get compatible repositories for provisioning a new VDB by location.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: LocationCompatibleEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /environments/{environmentId}/repository/{repositoryId}:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    - $ref: '#/components/parameters/repositoryIdParam'
    patch:
      tags:
      - Environments
      summary: Update a Repository.
      operationId: update_repository
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_repository_parameters
              $ref: '#/components/schemas/UpdateRepositoryParameters'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateRepositoryResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - Environments
      summary: Delete a repository.
      operationId: delete_repository
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RepositoryDeleteJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/repository:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      summary: Create a repository.
      operationId: create_repository
      tags:
      - Environments
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: create_repository
              $ref: '#/components/schemas/CreateRepositoryParams'
            examples:
              oracle_repository:
                description: The request example is intended for creating a oracle repository.
                summary: Oracle - Repository
                value:
                  database_type: ORACLE
                  bits: 32
                  installation_home: /u01/app/oracle/product/18.0.0.0/dbhome_1
                  version: 18.3.0.0.0
              mssql_repository:
                description: The request example is intended for creating a mssql repository.
                summary: MSSql - Repository
                value:
                  database_type: MSSQL
                  installation_home: C:/Program Files/Microsoft SQL Server/130
                  version: 13.2.5233.0
                  full_text_installed: true
                  instance_owner: qa-ad\delphix
                  instance_name: SQL2016
                  port: 49854
              ase_repository:
                description: The request example is intended for creating a Sybase ASE repository.
                summary: ASE - Repository
                value:
                  database_type: ASE
                  installation_path: /opt/sybase/16-0/install
                  instance_owner: sybase
                  instance_name: ASE160_SRC
                  port: 5500
        required: true
      responses:
        '201':
          description: Repository creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateRepositoryResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  repository_id:
                    type: string
                    description: The id of the created repository.
                    example: 1-ORACLE_INSTALL-15
  /environments/{environmentId}/hosts:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Create a new Host.
      operationId: create_host
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: create_host_parameters
              $ref: '#/components/schemas/HostCreateParameters'
        required: true
      responses:
        '201':
          description: Host Creation initiated
          content:
            application/json:
              schema:
                type: object
                title: CreateHostResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  cluster_node_id:
                    type: string
                    description: The id of the created cluster node.
                    example: ORACLE_CLUSTER_NODE-7
  /environments/{environmentId}/hosts/{hostId}:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    - $ref: '#/components/parameters/hostIdParam'
    patch:
      tags:
      - Environments
      summary: Update a Host.
      operationId: update_host
      requestBody:
        $ref: '#/components/requestBodies/UpdateHost'
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateHostResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - Environments
      summary: Delete a Host.
      operationId: delete_host
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteHostResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/tags:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Create tags for an Environment.
      operationId: create_environment_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: environment_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Environment.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - Environments
      summary: Get tags for an Environment.
      operationId: get_tags_environment
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /environments/{environmentId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Delete tags for an Environment.
      operationId: delete_environment_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /environments/{environmentId}:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    get:
      summary: Returns an environment by ID.
      operationId: get_environment_by_id
      tags:
      - Environments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
    delete:
      summary: Delete an environment by ID.
      operationId: delete_environment
      tags:
      - Environments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    patch:
      summary: Update an environment by ID.
      operationId: update_environment
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/UpdateEnvironment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/search:
    post:
      summary: Search for environments.
      operationId: search_environments
      tags:
      - Environments
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          namespace:
            type: string
          is_cluster:
            type: boolean
          address:
            type: string
          cluster_home:
            type: string
          cluster_name:
            type: string
          scan:
            type: string
          remote_listener:
            type: string
          is_windows_target:
            type: boolean
          staging_environment:
            type: string
          enabled:
            type: boolean
          encryption_enabled:
            type: boolean
          description:
            type: string
          namespace_id:
            type: string
          namespace_name:
            type: string
          is_replica:
            type: boolean
          engine_id:
            type: string
          engine_name:
            type: string
          ase_db_user_name:
            type: string
          ase_db_credential_type:
            type: string
          ase_enable_tls:
            type: boolean
          ase_skip_server_certificate_validation:
            type: boolean
          hosts:
            type: array[object]
            fields:
              hostname:
                type: string
              os_name:
                type: string
              os_version:
                type: string
              memory_size:
                type: integer
              available:
                type: boolean
              available_timestamp:
                type: string
              not_available_reason:
                type: string
              nfs_addresses:
                type: array[string]
              dsp_keystore_alias:
                type: string
              dsp_keystore_path:
                type: string
              dsp_truststore_path:
                type: string
              java_home:
                type: string
              ssh_port:
                type: integer
              toolkit_path:
                type: string
              connector_port:
                type: integer
              connector_version:
                type: string
              connector_dot_net_framework_version:
                type: string
              oracle_tde_keystores_root_path:
                type: string
              oracle_tde_okv_home_path:
                type: string
              processor_type:
                type: string
              timezone:
                type: string
              powershell_version:
                type: string
              release:
                type: string
              is_tde_external_key_manager_password_set:
                type: boolean
              distribution:
                type: string
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
          repositories:
            type: array[object]
            fields:
              id:
                type: string
              name:
                type: string
              database_type:
                type: string
              allow_provisioning:
                type: boolean
              is_staging:
                type: boolean
              oracle_base:
                type: string
              version:
                type: string
              bits:
                type: integer
              install_group:
                type: string
              install_user:
                type: string
              rac:
                type: boolean
              ports:
                type: array[integer]
              port:
                type: integer
              dump_history_file:
                type: string
              page_size:
                type: integer
              owner:
                type: string
              installation_path:
                type: string
              fulltext_installed:
                type: boolean
              internal_version:
                type: integer
              mssql_cluster_instances_name:
                type: array[string]
              mssql_cluster_instances_version:
                type: array[string]
              mssql_cluster_instances_owners:
                type: array[string]
              mssql_cluster_instances_ports:
                type: array[string]
              mssql_cluster_instances_server_names:
                type: array[string]
              mssql_cluster_instances_nodes:
                type: array[string]
              installation_home:
                type: string
              mssql_listeners:
                type: array[object]
                fields:
                  type:
                    type: string
                  name:
                    type: string
                  address:
                    type: string
                  port:
                    type: integer
              database_username:
                type: string
              service_principal_name:
                type: string
              isql_path:
                type: string
              ase_tls_enabled:
                type: boolean
              credential_type:
                type: string
          listeners:
            type: array[object]
            fields:
              id:
                type: string
              namespace:
                type: string
              name:
                type: string
              client_endpoints:
                type: array[string]
              is_discovered:
                type: boolean
              host_id:
                type: string
              protocol_addresses:
                type: array[string]
          env_users:
            type: array[object]
            fields:
              user_ref:
                type: string
              username:
                type: string
              auth_type:
                type: string
              vault:
                type: string
              hashicorp_vault_engine:
                type: string
              hashicorp_vault_secret_path:
                type: string
              hashicorp_vault_username_key:
                type: string
              hashicorp_vault_secret_key:
                type: string
              cyberark_vault_query_string:
                type: string
              azure_vault_name:
                type: string
              azure_vault_username_key:
                type: string
              azure_vault_secret_key:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/envSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchEnvironmentsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /environments/{environmentId}/enable:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Enable a disabled environment.
      operationId: enable_environment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: EnableEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/disable:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Disable environment.
      operationId: disable_environment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DisableEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/refresh:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Refresh environment.
      operationId: refresh_environment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RefreshEnvironmentResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/users:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Create environment user.
      operationId: create_environment_user
      requestBody:
        $ref: '#/components/requestBodies/CreateEnvironmentUserBody'
      responses:
        '201':
          description: Environment user created
          content:
            application/json:
              schema:
                type: object
                title: CreateEnvironmentUserResponse
                properties:
                  user_ref:
                    type: string
                    description: The reference of the created environment user
                    example: user-reference-1
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    get:
      tags:
      - Environments
      summary: List environment users.
      operationId: list_environment_users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentUsers'
  /environments/{environmentId}/users/{userRef}:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    - $ref: '#/components/parameters/userRefParam'
    put:
      tags:
      - Environments
      summary: Update environment user.
      operationId: update_environment_user
      requestBody:
        $ref: '#/components/requestBodies/CreateEnvironmentUserBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateEnvironmentUserResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - Environments
      summary: Delete environment user.
      operationId: delete_environment_user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteEnvironmentUserResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/users/{userRef}/primary:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    - $ref: '#/components/parameters/userRefParam'
    post:
      tags:
      - Environments
      summary: Set primary environment user.
      operationId: primary_environment_user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: PrimaryEnvironmentUserResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/listeners:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    post:
      tags:
      - Environments
      summary: Create Oracle listener.
      operationId: create_oracle_listener
      requestBody:
        $ref: '#/components/requestBodies/CreateOracleListenerBody'
      responses:
        '201':
          description: Oracle listener created
          content:
            application/json:
              schema:
                type: object
                title: CreateOracleListenerResponse
                properties:
                  listener_ref:
                    type: string
                    description: The reference of the created Oracle listener
                    example: ORACLE_NODE_LISTENER-9
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/{environmentId}/listeners/{listenerId}:
    parameters:
    - $ref: '#/components/parameters/environmentIdParam'
    - $ref: '#/components/parameters/listenerIdParam'
    patch:
      tags:
      - Environments
      summary: Update an Oracle listener.
      operationId: update_oracle_listener
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_oracle_listener_parameters
              $ref: '#/components/schemas/UpdateOracleListenerParams'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateOracleListenerResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - Environments
      summary: Delete an Oracle listener.
      operationId: delete_oracle_listener
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteOracleListenerResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /environments/hosts/{hostId}:
    parameters:
    - $ref: '#/components/parameters/hostIdParam'
    get:
      tags:
      - Environments
      summary: Fetch an environment host by host id.
      operationId: get_host_by_id
      responses:
        '200':
          description: Returns a single environment host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Host'
  /environments/hosts/{hostId}/okv-clients:
    parameters:
    - $ref: '#/components/parameters/hostIdParam'
    get:
      tags:
      - Environments
      summary: List OKV clients running on the specified host.
      operationId: list_okv_clients
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListOkvClientsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/OkvClient'
    post:
      summary: Create an OKV Client for the specific host.
      operationId: create_okv_client
      tags:
      - Environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOkvClientParameters'
        description: The parameters to create an OKV client.
        required: true
      responses:
        '201':
          description: OKV Client created
          content:
            application/json:
              schema:
                type: object
                title: CreateOkvClientResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  okv_client_id:
                    type: string
                    description: The id of the created OKV client.
  /environments/hosts/okv-clients/{okvClientId}:
    parameters:
    - $ref: '#/components/parameters/okvClientIdParam'
    get:
      tags:
      - Environments
      summary: Fetch an OKV Client by okvClient id.
      operationId: get_okv_client_by_id
      responses:
        '200':
          description: Returns a single OKV client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkvClient'
        '404':
          description: OKV client not found
    delete:
      tags:
      - Environments
      summary: Delete an OKV Client
      operationId: delete_okv_client
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteOkvClientResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    patch:
      tags:
      - Environments
      summary: Update an OKV Client.
      operationId: update_okv_client
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOkvClientParameters'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
     

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