Delphix VCDBs API

openapi: 3.2.0
info:
  title: Delphix DCT VCD Bs 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: VCDBs
paths:
  /vcdbs:
    get:
      summary: List all vCDBs (Oracle only)
      operationId: get_vcdbs
      tags:
      - VCDBs
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vcdbsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListVCDBsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VCDB'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /vcdbs/search:
    post:
      summary: Search for vCDBs (Oracle only)
      operationId: search_vcdbs
      tags:
      - VCDBs
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          description:
            type: string
          database_name:
            type: string
          database_version:
            type: string
          environment_id:
            type: string
          size:
            type: integer
          engine_id:
            type: string
          status:
            type: string
          parent_id:
            type: string
          creation_date:
            type: string
          group_name:
            type: string
          enabled:
            type: boolean
          content_type:
            type: string
          namespace_id:
            type: string
          namespace_name:
            type: string
          is_replica:
            type: boolean
          vcdb_restart:
            type: boolean
          invoke_datapatch:
            type: boolean
          node_listeners:
            type: array[string]
          instance_name:
            type: string
          instance_number:
            type: integer
          repository_id:
            type: string
          containerization_state:
            type: string
          tde_key_identifier:
            type: string
          tde_keystore_config_type:
            type: string
          is_tde_keystore_password_set:
            type: boolean
          database_unique_name:
            type: string
          db_username:
            type: string
          redo_log_groups:
            type: integer
            format: int32
          redo_log_size_in_mb:
            type: integer
            format: int32
          nfs_version:
            type: integer
            format: int32
          nfs_version_reason:
            type: string
          nfs_encryption_enabled:
            type: boolean
          environment_user_ref:
            type: string
          db_template_id:
            type: string
          db_template_name:
            type: string
          okv_client_id:
            type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vcdbsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchVCDBsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VCDB'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /vcdbs/{vcdbId}:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    get:
      summary: Get a vCDB by ID (Oracle only)
      operationId: get_vcdb_by_id
      tags:
      - VCDBs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCDB'
    patch:
      tags:
      - VCDBs
      summary: Update values of a VCDB
      operationId: update_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_vcdb_parameter
              $ref: '#/components/schemas/UpdateVCDBParameters'
        description: The parameters to update a VCDB.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/tags:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      tags:
      - VCDBs
      summary: Create tags for a vCDB
      operationId: create_vcdb_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: vcdb_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for vCDB.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - VCDBs
      summary: Get tags for a vCDB
      operationId: get_tags_vcdb
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /vcdbs/{vcdbId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      tags:
      - VCDBs
      summary: Delete tags for a vCDB
      operationId: delete_vcdb_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /vcdbs/{vcdbId}/enable:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      tags:
      - VCDBs
      summary: Enable a vCDB
      operationId: enable_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: enable_vcdb_parameter
              $ref: '#/components/schemas/EnableVCDBParameters'
        description: The parameters to enable a vCDB.
      responses:
        '200':
          description: vCDB enable initiated.
          content:
            application/json:
              schema:
                title: EnableVCDBResponse
                type: object
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /vcdbs/{vcdbId}/disable:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      summary: Disable a vCDB
      tags:
      - VCDBs
      operationId: disable_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: disable_vcdb_parameter
              $ref: '#/components/schemas/DisableVCDBParameters'
        description: The parameters to disable a vCDB.
      responses:
        '200':
          description: vCDB disable initiated.
          content:
            application/json:
              schema:
                type: object
                title: DisableVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/deletion-dependencies:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    get:
      summary: Get deletion dependencies of a vCDB
      operationId: get_vcdb_deletion_dependencies
      tags:
      - VCDBs
      responses:
        '200':
          description: Deletion dependencies of a vCDB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletionDependenciesResponse'
  /vcdbs/{vcdbId}/delete:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      summary: Delete a vCDB
      tags:
      - VCDBs
      operationId: delete_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: delete_vcdb_parameter
              $ref: '#/components/schemas/DeleteVCDBParameters'
        description: The parameters to delete a vCDB.
      responses:
        '200':
          description: vCDB delete initiated.
          content:
            application/json:
              schema:
                type: object
                title: DeleteVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/update:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    patch:
      deprecated: true
      summary: Update a VCDB
      tags:
      - VCDBs
      operationId: update_vcdb_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_vcdb_parameter
              $ref: '#/components/schemas/UpdateVCDBParameters'
        description: The parameters to update a VCDB.
      responses:
        '200':
          description: VCDB update initiated.
          content:
            application/json:
              schema:
                type: object
                title: UpdateVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/start:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      summary: Start a vCDB
      tags:
      - VCDBs
      operationId: start_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: StartVcdbParameters
              $ref: '#/components/schemas/StartVCDBParameters'
        required: false
      responses:
        '200':
          description: vCDB start initiated.
          content:
            application/json:
              schema:
                type: object
                title: StartVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/stop:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      summary: Stop a vCDB
      tags:
      - VCDBs
      operationId: stop_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: StopVcdbParameters
              $ref: '#/components/schemas/StopVCDBParameters'
        required: false
      responses:
        '200':
          description: vCDB stop initiated.
          content:
            application/json:
              schema:
                type: object
                title: StopVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/upgrade:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      summary: Upgrade Oracle vCDB
      tags:
      - VCDBs
      operationId: upgrade_vcdb
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: upgrade_oracle_vcdb_parameters
              $ref: '#/components/schemas/UpgradeOracleContainerDatabaseParameters'
        description: The new data to upgrade an Oracle vCDB.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpgradeVCDBResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vcdbs/{vcdbId}/jdbc-check:
    parameters:
    - $ref: '#/components/parameters/vcdbIdParam'
    post:
      tags:
      - VCDBs
      summary: Verify JDBC connection string for a vCDB
      operationId: verify_vcdb_jdbc_connection_string
      requestBody:
        $ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
      responses:
        '200':
          description: Success or Failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectivityCheckResponse'
components:
  schemas:
    OracleTdeKeystoreConfigTypeEnum:
      type: string
      description: Oracle TDE keystore configuration type.
      enum:
      - FILE
      - OKV
      - HSM
      - OKV|FILE
      - FILE|OKV
      - HSM|FILE
      - FILE|HSM
      - OCI_VAULT
      - UNSET
    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
    NfsVersionReasonEnum:
      type: string
      description: The reason why the source is being mounted with nfsVersion.
      enum:
      - DEFAULT
      - OLD_REDHAT
      - UNSUPPORTED_OS
      - DNFS
      - TUNABLE_OVERRIDE
      - NO_RECOVER_LOST_LOCKS
      - UNSUPPORTED_DATA_PLATFORM
      - INCOMPLETE_V4_CONFIG
      - DNFS_UNSUPPORTED_ORACLE_VERSIONS_1912_1915
      - DNFS_UNSUPPORTED_ORACLE_VERSIONS_211_216
      - DNFS_UNSUPPORTED_ORACLE_VERSIONS_LESS_THAN_12C
    OracleCustomEnvVar:
      type: object
      properties:
        cluster_node:
          type: string
          description: The cluster node on which the environment variable is relevant.
        path_parameters:
          type: string
          description: A string of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file.
        var_name:
          type: string
          description: The name of the environment variable.
        var_value:
          description: The value of the environment variable.
          type: string
    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
    OracleRacCustomEnvVar:
      type: object
      properties:
        node_id:
          type: string
          minLength: 1
          maxLength: 256
        name:
          type: string
          minLength: 1
          maxLength: 4096
        value:
          type: string
          minLength: 1
          maxLength: 4096
    VirtualizationTask:
      deprecated: true
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    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'
    ConnectivityCheckResponse:
      title: ConnectivityResponse
      type: object
      description: The result of the connectivity check.
      required:
      - message
      properties:
        message:
          description: A message describing the result of the connectivity check.
          type: string
          example: Success!
        status:
          description: A status describing the status of the connectivity check.
          type: string
          enum:
          - SUCCESS
          - FAILED
          example: SUCCESS
    SearchBody:
      description: Search body.
      type: object
      properties:
        filter_expression:
          type: string
          minLength: 5
          maxLength: 50000
          example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
    ContainerizationStateEnum:
      type: string
      description: Indicates the virtual database's containerization state, created for or running inside a containerized environment like Linux containers.
      enum:
      - NOT_CONTAINERIZED
      - READY_FOR_CONTAINER
      - RUNNING_IN_CONTAINER
    JobTask:
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    EnableVCDBParameters:
      type: object
      description: Parameters to enable a vCDB.
      properties:
        attempt_start:
          type: boolean
          description: Whether to attempt a startup of the vCDB after the enable.
          default: true
    OracleVerifyJdbcConnectionStringParams:
      type: object
      required:
      - database_username
      - database_password
      - jdbc_connection_string
      properties:
        database_username:
          type: string
          description: oracle database username.
          example: oracle
        database_password:
          x-dct-toolkit-credential-field: true
          type: string
          description: oracle database password.
          example: oracle
        jdbc_connection_string:
          type: string
          description: Oracle jdbc connection string to validate.
          example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.219.71)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=CDOMLOSR25E9PDB1)))
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    OracleRACDatabaseInstance:
      type: object
      required:
      - instance_name
      - instance_number
      - node_reference
      properties:
        instance_name:
          type: string
          description: The name of this instance. Must contain at least one non-whitespace character.
          minLength: 1
          pattern: .*\S.*
        instance_number:
          type: integer
          description: The number of this instance.
          minimum: 1
        node_reference:
          type: string
          description: The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.
          minLength: 1
          pattern: .*\S.*
        okv_client_id:
          description: The id of the OKV client used for TDE keystore access. If provided, it must include at least one non-whitespace character; if omitted, the existing OKV client will be cleared.
          type: string
          minLength: 1
          pattern: .*\S.*
          example: 1-ORACLE_OKV_CLIENT-1
    UpgradeOracleContainerDatabaseParameters:
      type: object
      description: Parameters to upgrade CDB/vCDB.
      required:
      - repository_id
      - environment_user_id
      properties:
        repository_id:
          type: string
          description: The id of the CDB/vCDB repository to upgrade to.
          example: 1-ORACLE_INSTALL-4
        environment_user_id:
          type: string
          description: Reference of the environment user to use for CDB/vCDB upgrade.
          example: HOST_USER-4
    DisableVCDBParameters:
      type: object
      description: Parameters to disable a vCDB.
      properties:
        attempt_cleanup:
          type: boolean
          description: Whether to attempt a cleanup of the vCDB before the disable.
          default: true
    EngineStorageCapacityDependencyData:
      description: Engine storage capacity dependency data.
      allOf:
      - $ref: '#/components/schemas/EngineStorageCapacityData'
      - type: object
        properties:
          parent_id:
            type: string
            description: ID of the parent dataset.
    OracleRacCustomEnvFile:
      type: object
      properties:
        node_id:
          type: string
          minLength: 1
          maxLength: 256
        path_parameters:
          type: string
    TagsRequest:
      type: object
      required:
      - tags
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          minItems: 1
          maxItems: 1000
          uniqueItems: true
    TagsResponse:
      type: object
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    UpdateVCDBParameters:
      type: object
      description: Parameters to update a VCDB.
      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
        okv_client_id:
          description: The id of the OKV client used for TDE keystore access. A blank string will unset the existing OKV client id.
          type: string
          example: 1-ORACLE_OKV_CLIENT-1
        instance_name:
          description: The instance name of this single instance CDB. Must contain at least one non-whitespace character.
          type: string
          minLength: 1
          pattern: .*\S.*
          example: CDBSID
        instance_number:
          description: The instance number of this single instance CDB.
          type: integer
          minimum: 1
          example: 1
        instances:
          type: array
          description: The instances of this RAC database.
          items:
            $ref: '#/components/schemas/OracleRACDatabaseInstance'
          minItems: 1
          example:
          - instance_name: instance1
            instance_number: 1
            node_reference: ORACLE_CLUSTER_NODE-1
            okv_client_id: 1-ORACLE_OKV_CLIENT-1
        node_listeners:
          description: The list of node listener ids for this VCDB.
          type: array
          items:
            type: string
          example:
          - 1-ORACLE_NODE_LISTENER-2
          - 1-ORACLE_NODE_LISTENER-3
        invoke_datapatch:
          description: Indicates whether datapatch should be invoked.
          type: boolean
        tde_keystore_password:
          x-dct-toolkit-credential-field: true
          description: For a vCDB using software keystore, this is the password of the software keystore used by this database. For a vCDB using OKV, this is the password for the endpoint provided during the installation of the Oracle Key Vault client library (i.e., okvclient.jar) on the host where this database runs. For a vCDB using HSM, this is the credential of the external key manager which is managing master encryption keys of this database. A blank string will unset the existing tde keystore password.
          type: string
          maxLength: 128
          example: password
        tde_keystore_config_type:
          description: The TDE keystore configuration type of this database.
          $ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum'
          example: OKV
        tde_key_identifier:
          description: The master encryption key id of this database. A blank string will unset the existing tde key identifier.
          type: string
          maxLength: 78
          example: 0692EFF441BB604F82BFDAD4D2D4181B30
        db_username:
          type: string
          description: The username of the database user.
          minLength: 1
          maxLength: 256
          example: db-username
        db_password:
          x-dct-toolkit-credential-field: true
          type: string
          description: The password of the database user.
          minLength: 1
          maxLength: 256
          example: db-password
        auto_restart:
          type: boolean
          description: Whether to enable VDB restart.
        environment_user_id:
          type: string
          description: The environment user ID to use to connect to the target environment.
          minLength: 1
          maxLength: 256
          example: environment-user-123
        config_params:
          description: Database configuration parameter overrides.
          type: object
          additionalProperties: true
          example:
            processes: 150
        custom_env_vars:
          description: Environment variable to be set when the engine administers a VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled.
          type: object
          additionalProperties:
            type: string
            minLength: 1
            maxLength: 4096
          example:
            MY_ENV_VAR1: $ORACLE_HOME
            MY_ENV_VAR2: $CRS_HOME/after
        custom_env_files:
          description: Environment files to be sourced when the Engine administers a VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled.
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 4096
          example:
          - /export/home/env_file_1
        

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