Delphix VDBGroups API

openapi: 3.2.0
info:
  title: Delphix DCT VDB Groups 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: VDBGroups
paths:
  /vdb-groups:
    get:
      summary: List all VDBGroups
      operationId: get_vdb_groups
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vdbGroupsSortParam'
      tags:
      - VDBGroups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListVDBGroupsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VDBGroup'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      summary: Create a new VDB Group
      tags:
      - VDBGroups
      operationId: create_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: CreateVDBGroupRequest
              required:
              - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                vdb_ids:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 256
                  minItems: 1
                vdbs:
                  type: array
                  maxItems: 256
                  description: Dictates order of operations on VDBs. Operations can be performed in parallel <br> for all VDBs or sequentially. Below are possible valid and invalid orderings given an example <br> VDB group with 3 vdbs (A, B, and C).<br> Valid:<br> {"vdb_id":"vdb-1", "order":"1"} {"vdb_id":"vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel)<br> {vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential)<br> Invalid:<br> {vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential)<br><br> In the sequential case the vdbs with priority 1 is the first to be started and the last to<br> be stopped. This value is set on creation of VDB groups.
                  items:
                    $ref: '#/components/schemas/CreateVDBGroupOrder'
                  minItems: 1
                tags:
                  type: array
                  maxItems: 1000
                  description: The tags to be created for VDB Group.
                  items:
                    $ref: '#/components/schemas/Tag'
                  minItems: 1
                make_current_account_owner:
                  type: boolean
                  default: true
                  description: Whether the account creating this VDB group must be configured as owner of the VDB group.
                refresh_immediately:
                  type: boolean
                  default: false
                  description: If true, VDB Group will be refreshed immediately after creation.
        description: The parameters to create a VDB Group.
        required: true
      responses:
        '201':
          description: VDB Group Created.
          content:
            application/json:
              schema:
                type: object
                title: CreateVDBGroupResponse
                properties:
                  vdb_group:
                    $ref: '#/components/schemas/VDBGroup'
                  job:
                    $ref: '#/components/schemas/Job'
                    description: Initiated refresh job.
  /vdb-groups/provision_from_bookmark:
    post:
      summary: Provision a new VDB Group from a Bookmark
      tags:
      - VDBGroups
      operationId: provision_vdb_group_from_bookmark
      requestBody:
        $ref: '#/components/requestBodies/ProvisionVDBGroupFromBookmark'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ProvisionVDBGroupFromBookmarkResponse
                properties:
                  vdb_group:
                    $ref: '#/components/schemas/VDBGroup'
                  job:
                    $ref: '#/components/schemas/Job'
                    description: Initiated job.
  /vdb-groups/search:
    post:
      summary: Search for VDB Groups
      operationId: search_vdb_groups
      tags:
      - VDBGroups
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          is_locked:
            type: boolean
          locked_by:
            type: integer
            format: int64
          locked_by_name:
            type: string
          vdb_group_source:
            type: string
          ss_data_layout_id:
            type: string
          vdb_ids:
            type: array[string]
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vdbGroupsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchVDBGroupResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VDBGroup'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /vdb-groups/{vdbGroupId}:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    get:
      summary: Get a VDB Group by name
      operationId: get_vdb_group
      tags:
      - VDBGroups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VDBGroup'
    patch:
      tags:
      - VDBGroups
      summary: Update values of a VDB group
      operationId: update_vdb_group_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_vdb_group_parameter
              $ref: '#/components/schemas/UpdateVDBGroupParameters'
        description: The new data to update a VDB group.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateVDBGroupResponse
                allOf:
                - $ref: '#/components/schemas/VDBGroup'
                - type: object
                  properties:
                    job:
                      $ref: '#/components/schemas/Job'
                      description: The initiated job.
    delete:
      summary: Delete a VDBGoup
      operationId: delete_vdb_group
      tags:
      - VDBGroups
      responses:
        '204':
          description: No Content
  /vdb-groups/{vdbGroupId}/latest-snapshots:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    get:
      tags:
      - VDBGroups
      summary: Get latest snapshot of all the vdbs in VDB Group
      operationId: get_vdb_group_vdbs_latest_snapshots
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: LatestSnapshotsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Snapshot'
  /vdb-groups/{vdbGroupId}/timestamp-summary:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      tags:
      - VDBGroups
      summary: Get timestamp summary of all the vdbs in VDB Group
      operationId: get_vdb_group_timestamp_summary
      requestBody:
        content:
          application/json:
            schema:
              title: VDBGroupTimestampSummaryRequest
              type: object
              properties:
                timestamp:
                  type: string
                  format: date-time
                  description: The timestamp to get the summary for.
                vdb_ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  uniqueItems: true
                  description: vdb ids for which summary is needed.
                mode:
                  $ref: '#/components/schemas/RefreshModeEnum'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: VdbGroupTimestampSummaryResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: Initiated job.
  /vdb-groups/{vdbGroupId}/tags:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      tags:
      - VDBGroups
      summary: Create tags for a VDB Group
      operationId: create_vdb_groups_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: vdb_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for VDB Group.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - VDBGroups
      summary: Get tags for a VDB Group
      operationId: get_vdb_group_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /vdb-groups/{vdbGroupId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      tags:
      - VDBGroups
      summary: Delete tags for a VDB Group
      operationId: delete_vdb_group_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /vdb-groups/{vdbGroupId}/refresh:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      deprecated: true
      summary: Refresh a VDB Group from bookmark
      description: This API is marked as deprecated in favour of renamed API '/vdb-groups/{vdbGroupId}/refresh_from_bookmark'
      tags:
      - VDBGroups
      operationId: refresh_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_vdb_group_parameters
              $ref: '#/components/schemas/RefreshVDBGroupParameters'
        description: The parameters to refresh a VDB Group.
      responses:
        '200':
          description: VDB Group refresh initiated.
          content:
            application/json:
              schema:
                type: object
                title: RefreshVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/refresh_from_bookmark:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Refresh a VDB Group from bookmark
      tags:
      - VDBGroups
      operationId: refresh_vdb_group_from_bookmark
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_vdb_group_parameters
              $ref: '#/components/schemas/RefreshVDBGroupParameters'
        description: The parameters to refresh a VDB Group.
      responses:
        '200':
          description: VDB Group refresh initiated.
          content:
            application/json:
              schema:
                type: object
                title: RefreshVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/refresh_by_snapshot:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Refresh a VDB Group by snapshot
      tags:
      - VDBGroups
      operationId: refresh_vdb_group_by_snapshot
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_vdb_group_by_snapshot_params
              $ref: '#/components/schemas/RefreshVDBGroupBySnapshotParameters'
        description: The parameters to refresh a VDB Group by snapshot.
      responses:
        '200':
          description: VDB Group refresh initiated.
          content:
            application/json:
              schema:
                type: object
                title: RefreshVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/refresh_by_timestamp:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Refresh a VDB Group by timestamp
      tags:
      - VDBGroups
      operationId: refresh_vdb_group_by_timestamp
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_vdb_group_by_timestamp
              $ref: '#/components/schemas/RefreshVDBGroupByTimestampParameters'
        description: The parameters to refresh a VDB Group by timestamp.
      responses:
        '200':
          description: VDB Group refresh initiated.
          content:
            application/json:
              schema:
                type: object
                title: RefreshVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/rollback:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      deprecated: true
      summary: Rollback a VDB Group from a bookmark
      description: This API is marked as deprecated in favour of API '/vdb-groups/{vdbGroupId}/refresh_from_bookmark'
      tags:
      - VDBGroups
      operationId: rollback_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: rollback_vdb_group_parameters
              $ref: '#/components/schemas/RollbackVDBGroupParameters'
        description: The parameters to rollback a VDB Group.
      responses:
        '200':
          description: VDB Group rollback initiated.
          content:
            application/json:
              schema:
                type: object
                title: RollbackVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/bookmarks:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    get:
      summary: List bookmarks compatible with this VDB Group
      operationId: get_bookmarks_by_vdb_group
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/bookmarksSortParam'
      tags:
      - VDBGroups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListBookmarksByVDBGroupsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bookmark'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /vdb-groups/{vdbGroupId}/bookmarks/search:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      tags:
      - VDBGroups
      summary: Search for bookmarks compatible with this VDB Group
      operationId: search_bookmarks_by_vdb_group
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          vdb_group_name:
            type: string
          creation_date:
            type: string
          vdb_ids:
            type: array[string]
          retention:
            type: integer
          expiration:
            type: string
          ss_data_layout_id:
            type: string
          ss_bookmark_reference:
            type: string
          ss_bookmark_errors:
            type: array[string]
          vdbs:
            type: array[object]
            fields:
              vdb_id:
                type: string
              vdb_name:
                type: string
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/bookmarksSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchBookmarksByVDBGroupsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bookmark'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /vdb-groups/{vdbGroupId}/lock:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Lock a VDB Group
      tags:
      - VDBGroups
      operationId: lock_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: LockVDBGroupParameters
              properties:
                account_id:
                  description: Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDB Groups on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used.
                  type: integer
                  format: int64
        description: The parameters to lock a VDB Group.
        required: true
      responses:
        '200':
          description: VDB Group is locked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VDBGroup'
  /vdb-groups/{vdbGroupId}/unlock:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Unlock a VDB Group
      tags:
      - VDBGroups
      operationId: unlock_vdb_group
      responses:
        '200':
          description: VDB Group is unlocked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VDBGroup'
  /vdb-groups/{vdbGroupId}/start:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Start a VDB Group
      tags:
      - VDBGroups
      operationId: start_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: start_vdb_group_params
              $ref: '#/components/schemas/StartVDBGroupParameters'
        description: The parameters to start a VDB Group.
      responses:
        '200':
          description: VDB Group start is initiated.
          content:
            application/json:
              schema:
                type: object
                title: StartVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/stop:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Stop a VDB Group
      tags:
      - VDBGroups
      operationId: stop_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: stop_vdb_group_params
              $ref: '#/components/schemas/StopVDBGroupParameters'
        description: The parameters to stop a VDB Group.
      responses:
        '200':
          description: VDB Group stop is initiated.
          content:
            application/json:
              schema:
                type: object
                title: StopVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/enable:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Enable a VDB Group
      tags:
      - VDBGroups
      operationId: enable_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: enable_vdb_group_params
              $ref: '#/components/schemas/EnableVDBGroupParameters'
        description: The parameters to enable a VDB Group.
      responses:
        '200':
          description: VDB Group enable is initiated.
          content:
            application/json:
              schema:
                type: object
                title: EnableVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /vdb-groups/{vdbGroupId}/disable:
    parameters:
    - $ref: '#/components/parameters/vdbGroupIdParam'
    post:
      summary: Disable a VDB Group
      tags:
      - VDBGroups
      operationId: disable_vdb_group
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: disable_vdb_group_params
              $ref: '#/components/schemas/DisableVDBGroupParameters'
        description: The parameters to disable a VDB Group.
      responses:
        '200':
          description: VDB Group disable is initiated.
          content:
            application/json:
              schema:
                type: object
                title: DisableVDBGroupResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
components:
  schemas:
    StartVDBGroupParameters:
      type: object
      description: Parameters to start a VDB Group.
      properties:
        vdb_start_param_mappings:
          type: array
          items:
            $ref: '#/components/schemas/VDBStartParametersMapping'
    OracleTdeKeystoreConfigTypeEnum:
      type: string
      description: Oracle TDE keystore configuration type.
      enum:
      - FILE
      - OKV
      - HSM
      - OKV|FILE
      - FILE|OKV
      - HSM|FILE
      - FILE|HSM
      - OCI_VAULT
      - UNSET
    BookmarkPaaSInstances:
      description: PaaS Instance id and name associated with bookmark.
      type: object
      properties:
        paas_instance_id:
          description: The PaaS Instance id.
          type: string
          example: paas-instance-id-1
        paas_instance_name:
          description: The PaaS Instance name.
          type: string
          example: paas-instance-name
        root_parent_id:
          description: The root of the PaaS Instance.
          type: string
          example: paas-instance-root-id-1
        paas_snapshot_id:
          description: The PaaS Instance snapshot id.
          type: string
          example: 1-SNAP-1
        data_timestamp:
          description: The timestamp of the PaaS Instance snapshot.
          type: string
          format: date-time
          example: '2021-05-01T08:51:34.148000+00:00'
    DisableVDBGroupParameters:
      type: object
      description: Parameters to disable a VDB Group.
      properties:
        vdb_disable_param_mappings:
          type: array
          items:
            $ref: '#/components/schemas/VDBDisableParametersMapping'
    Hook:
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
          example: Print the current user
        command:
          type: string
          minLength: 1
          example: whoami
        shell:
          type: string
          enum:
          - bash
          - shell
          - expect
          - ps
          - psd
          example: bash
        element_id:
          type: string
          minLength: 1
          maxLength: 256
          example: '3'
          description: Pass the element_id only when updating an existing hook, omit to create a new one.
        has_credentials:
          type: boolean
          example: false
        credentials_env_vars:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsEnvVariable'
        hook_template_id:
          type: string
          example: Hook Template 1
    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
    RefreshVDBGroupParameters:
      type: object
      description: Parameters to refresh a VDB Group.
      required:
      - bookmark_id
      properties:
        bookmark_id:
          type: string
          minLength: 1
          maxLength: 256
          description: ID of a bookmark to refresh this VDB Group to.
    VDBStartParametersMapping:
      description: Parameters to start a VDB.
      allOf:
      - $ref: '#/components/schemas/StartVDBParameters'
      - type: object
        required:
        - vdb_id
        properties:
          vdb_id:
            type: string
            description: ID of the VDB to start.
    DisableVDBParameters:
      type: object
      description: Parameters to disable a VDB.
      properties:
        attempt_cleanup:
          type: boolean
          description: Whether to attempt a cleanup of the VDB before the disable.
          default: true
        container_mode:
          type: boolean
          description: Whether the database is running inside a container.
      discriminator:
        propertyName: class_type
    StartVDBParameters:
      type: object
      description: Parameters to start a VDB.
      properties:
        instances:
          type: array
          items:
            type: integer
          description: List of specific Oracle Virtual Database Instances to start.
      discriminator:
        propertyName: class_type
    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
    RefreshVDBGroupBySnapshotParameters:
      type: object
      description: Parameters to refresh a VDB Group by snapshot.
      properties:
        vdb_snapshot_mappings:
          description: List of the pair of VDB and snapshot to refresh from. If this is not set, all VDBs will be refreshed from late

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