Delphix PaaSDatabases API

The PaaSDatabases API from Delphix — 15 operation(s) for paasdatabases.

Operations 17

GET /paas-databases List all PaaS Databases #
POST /paas-databases Provision a new PaaS Database #
POST /paas-databases/provision_from_bookmark Provision a new PaaS Database from a bookmark #
GET /paas-databases/{paaSDatabaseId}/bookmarks List Bookmarks compatible with this PaaS Database #
POST /paas-databases/{paaSDatabaseId}/bookmarks/search Search Bookmarks compatible with this PaaS Database #
POST /paas-databases/{paaSDatabaseId}/refresh_from_bookmark Refresh a PaaS Database from bookmark #
POST /paas-databases/search Search for PaaS Databases #
GET /paas-databases/{paaSDatabaseId} Get a PaaS Database by ID #
POST /paas-databases/{paaSDatabaseId}/delete Delete a PaaS Database #
POST /paas-databases/{paaSDatabaseId}/execute-compliance-job Execute the compliance job for a PaaS Database #
POST /paas-databases/{paaSDatabaseId}/create-compliance-connector Create a new compliance connector for the PaaS Database #
POST /paas-databases/{paaSDatabaseId}/refresh Refresh a PaaS Database #
POST /paas-databases/{paaSDatabaseId}/de-provision De-provision a PaaS Database, meaning that the database object will remain in… #
POST /paas-databases/{paaSDatabaseId}/re-provision Re-provision a PaaS Database which has previously been de-provisioned. #
POST /paas-databases/{paaSDatabaseId}/tags Create tags for a PaaS Database #
GET /paas-databases/{paaSDatabaseId}/tags Get tags for a PaaS Database #
POST /paas-databases/{paaSDatabaseId}/tags/delete Delete tags for a PaaS Database #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/delphix-paasdatabases-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

delphix-paasdatabases-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Delphix DCT Paa S Databases 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: PaaSDatabases
paths:
  /paas-databases:
    get:
      summary: List all PaaS Databases
      operationId: get_paas_databases
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/paasDatabaseSortParam'
      - $ref: '#/components/parameters/permission'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListPaaSDatabasesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PaaSDatabase'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      summary: Provision a new PaaS Database
      operationId: provision_paas_database
      tags:
      - PaaSDatabases
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: provision_paas_db_parameter
              $ref: '#/components/schemas/ProvisionPaaSDatabaseParameters'
        description: The parameters to provision a PaaS Database.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ProvisionPaaSDatabaseResponse
                properties:
                  paas_database_id:
                    type: string
                    description: The ID of the provisioned PaaS Database.
                  job:
                    $ref: '#/components/schemas/Job'
  /paas-databases/provision_from_bookmark:
    post:
      summary: Provision a new PaaS Database from a bookmark
      operationId: provision_paas_database_from_bookmark
      tags:
      - PaaSDatabases
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: provision_paas_db_from_bookmark_parameter
              $ref: '#/components/schemas/ProvisionPaaSDatabaseFromBookmarkParameters'
        description: The parameters to provision a PaaS Database from a bookmark.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ProvisionPaaSDatabaseFromBookmarkResponse
                properties:
                  paas_database_id:
                    type: string
                    description: The ID of the provisioned PaaS Database.
                  job:
                    type: object
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/bookmarks:
    parameters:
    - $ref: '#/components/parameters/paaSDatabaseIdParam'
    get:
      summary: List Bookmarks compatible with this PaaS Database
      operationId: get_bookmarks_by_paas_database
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/bookmarksSortParam'
      tags:
      - PaaSDatabases
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListBookmarksByPaaSDatabaseResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bookmark'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /paas-databases/{paaSDatabaseId}/bookmarks/search:
    parameters:
    - $ref: '#/components/parameters/paaSDatabaseIdParam'
    post:
      summary: Search Bookmarks compatible with this PaaS Database
      operationId: search_bookmarks_by_paas_database
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/bookmarksSortParam'
      tags:
      - PaaSDatabases
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          paas_databases:
            type: array[object]
            fields:
              paas_database_id:
                type: string
              paas_database_name:
                type: string
              paas_snapshot_id:
                type: string
              data_timestamp:
                type: date-time
          creation_date:
            type: date-time
          retention:
            type: integer
          expiration:
            type: date
          data_timestamp:
            type: date-time
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchBookmarksByPaaSDatabaseResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bookmark'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /paas-databases/{paaSDatabaseId}/refresh_from_bookmark:
    post:
      summary: Refresh a PaaS Database from bookmark
      operationId: refresh_paas_database_from_bookmark
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_paas_db_from_bookmark_parameter
              $ref: '#/components/schemas/RefreshPaaSDatabaseFromBookmarkParameters'
        description: The parameters to refresh a PaaS Database from a bookmark.
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: RefreshPaaSDatabasesFromBookmarkResponse
                properties:
                  job:
                    description: The job object.
                    type: object
                    $ref: '#/components/schemas/Job'
  /paas-databases/search:
    post:
      summary: Search for PaaS Databases
      operationId: search_paas_databases
      tags:
      - PaaSDatabases
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          plugin_id:
            type: string
          instance_id:
            type: string
          cloud_account_id:
            type: string
          cloud_account_name:
            type: string
          parent_snapshot_id:
            type: string
          parent_database_id:
            type: string
          status:
            type: string
          runtime_status:
            type: string
          connection_strings:
            type: array
            items: string
          database_engine:
            type: string
          database_engine_version:
            type: string
          compliance_connector_id: null
          is_encrypted:
            type: boolean
          platform_type:
            type: string
          platform_version:
            type: string
          owner:
            type: string
          root_database_id:
            type: string
          size_bytes:
            type: integer
          size_measurement_time:
            type: string
          size_measurement_source:
            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/paasDatabaseSortParam'
      - $ref: '#/components/parameters/permission'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchPaaSDatabasesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PaaSDatabase'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /paas-databases/{paaSDatabaseId}:
    parameters:
    - $ref: '#/components/parameters/paaSDatabaseIdParam'
    get:
      summary: Get a PaaS Database by ID
      operationId: get_paas_database_by_id
      tags:
      - PaaSDatabases
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaaSDatabase'
  /paas-databases/{paaSDatabaseId}/delete:
    post:
      summary: Delete a PaaS Database
      operationId: delete_paas_database
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: delete_paas_db_parameter
              $ref: '#/components/schemas/DeletePaaSDatabaseParameters'
        description: The parameters to delete a PaaS Database.
        required: false
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: DeletePaaSDatabaseResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/execute-compliance-job:
    post:
      summary: Execute the compliance job for a PaaS Database
      operationId: execute_paas_database_compliance_job
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: ExecutePaaSDatabaseComplianceJobResponse
                properties:
                  job:
                    description: The initiated job.
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/create-compliance-connector:
    post:
      summary: Create a new compliance connector for the PaaS Database
      operationId: create_paas_database_compliance_connector
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: create_paas_db_connector_parameter
              $ref: '#/components/schemas/CreatePaaSDatabaseConnectorParameters'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: CreatePaaSDatabaseConnectorResponse
                properties:
                  job:
                    description: The job object.
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/refresh:
    post:
      summary: Refresh a PaaS Database
      operationId: refresh_paas_database
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: refresh_paas_db_parameter
              $ref: '#/components/schemas/RefreshPaaSDatabaseParameters'
        description: The parameters to refresh a PaaS Database.
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: RefreshPaaSDatabasesResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/de-provision:
    post:
      summary: De-provision a PaaS Database, meaning that the database object will remain in…
      operationId: deprovision_paas_database
      tags:
      - PaaSDatabases
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: DeprovisionPaaSDatabasesResponse
                properties:
                  job:
                    description: The job object.
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/re-provision:
    post:
      summary: Re-provision a PaaS Database which has previously been de-provisioned.
      operationId: reprovision_paas_database
      tags:
      - PaaSDatabases
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: reprovision_paas_db_parameter
              $ref: '#/components/schemas/ReProvisionPaaSDatabaseParameters'
        description: The parameters to re-provision a PaaS Database.
        required: true
      parameters:
      - $ref: '#/components/parameters/paaSDatabaseIdParam'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                title: ReprovisionPaaSDatabaseResponse
                properties:
                  job:
                    description: The job object.
                    $ref: '#/components/schemas/Job'
  /paas-databases/{paaSDatabaseId}/tags:
    parameters:
    - $ref: '#/components/parameters/paaSDatabaseIdParam'
    post:
      tags:
      - PaaSDatabases
      summary: Create tags for a PaaS Database
      operationId: create_paas_database_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: paas_database_tags
              $ref: '#/components/schemas/CloudTagsRequest'
        description: Tags information for PaaS Database.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudTagsResponse'
    get:
      tags:
      - PaaSDatabases
      summary: Get tags for a PaaS Database
      operationId: get_paas_database_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudTagsResponse'
  /paas-databases/{paaSDatabaseId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/paaSDatabaseIdParam'
    post:
      tags:
      - PaaSDatabases
      summary: Delete tags for a PaaS Database
      operationId: delete_paas_database_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteCloudTags'
      responses:
        '204':
          description: No Content
components:
  schemas:
    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'
    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
    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
    RefreshPaaSDatabaseFromBookmarkParameters:
      type: object
      description: Parameters to refresh a PaaS Database from bookmark.
      required:
      - bookmark_id
      properties:
        bookmark_id:
          description: The ID of the PaaS Database bookmark to refresh from.
          type: string
          example: bookmark-123
    CloudTag:
      type: object
      required:
      - key
      - value
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
        mirror_on_cloud:
          description: Whether this tag is mirrored from/to the Cloud Provider account hosting the PaaS Database or Instance. Not applicable to non PaaS objects.
          type: boolean
          default: false
    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
    ProvisionPaaSDatabaseBaseParameters:
      description: Base parameters to provision a PaaS Database.
      type: object
      properties:
        make_current_account_owner:
          type: boolean
          default: true
          description: Whether the account creating this PaaS Database must be configured as owner of the PaaS Database.
        target_instance_id:
          description: The ID of the PaaS Instance to provision the database into. If not set, the database will be provisioned into the same Instance as the source database.
          type: string
          example: instance-123
        name:
          description: The provisioned PaaS Database name.
          type: string
          example: my-db-123
        provision_parameters:
          description: The parameters specified by the plugin schema for provisioning
          type:
          - object
          - 'null'
          additionalProperties: true
          example:
            foo: bar
        tags:
          type: array
          maxItems: 1000
          description: The tags to be created for PaaS Database.
          items:
            $ref: '#/components/schemas/CloudTag'
          minItems: 1
    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"
    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
    BookmarkVDBs:
      description: VDB id and name associated with bookmark.
      type: object
      properties:
        vdb_id:
          description: The VDB id.
          type: string
          example: vdb-id-1
        vdb_name:
          description: The VDB name.
          type: string
          example: vdb-name
        snapshot_id:
          description: The snapshot id.
          type: string
          example: 1-SNAP-1
        source_data_timestamp:
          description: The timestamp of origin timeline location.
          type: string
          format: date-time
          example: '2021-05-01T08:51:34.148000+00:00'
        root_parent_id:
          description: The root of the VDB.
          type: string
          example: 1-DBCONTAINER-1
        timeflow_id:
          description: The timeflow id of the snapshot.
          type: string
        data_timestamp:
          description: The bookmark timestamp of the VDB.
          type: string
          format: date-time
    PermissionEnum:
      description: Type of the permission on DCT object.
      type: string
      enum:
      - READ
      - UPDATE
      - DELETE
      - EXECUTE
      - CANCEL
      - MIGRATE
      - REFRESH
      - DISABLE
      - ENABLE
      - ABANDON
      - VALIDATE
      - START
      - STOP
      - SNAPSHOT
      - COPY
      - REMOVE_JOB
      - PASSWORD_RESET
      - UNDO_IMPORT
      - IMPORT
      - PROVISION_FROM_BOOKMARK
      - PROVISION
      - REFRESH_FROM_BOOKMARK
      - REFRESH_FROM_SNAPSHOT
      - REFRESH_FROM_TIMESTAMP
      - REFRESH_FROM_LOCATION
      - CREATE_ENVIRONMENT
      - CREATE_BOOKMARK
      - CREATE_VDBGROUP
      - MANAGE_TAGS
      - LINK
      - REPLICATE
      - REPLICATE_TO
      - CONVERT_AND_DROP
      - IMPORT_BOOKMARKS
      - FAILOVER
      - COMMIT_FAILOVER
      - FAILBACK
      - DISCARD
      - LOCK
      - UNLOCK
      - FORCE_UNLOCK
      - LOCK_FOR_OTHER_ACCOUNT
      - UPDATE_TIMEFLOW
      - SNAPSHOT_DELETE
      - SWITCH_TIMEFLOW
      - DELETE_TIMEFLOW
      - SNAPSHOT_UPDATE
      - IMPORT_ACCOUNTS
      - DETACH_SOURCE
      - ATTACH_SOURCE
      - RESOLVE
      - RESOLVE_ALL
      - RESOLVE_OR_IGNORE
      - API_KEY_RESET
      - API_KEY_DELETE
      - READ_STORAGE_CAPACITY_DATA
      - READ_DATASET_PERF_ANALYTICS
      - CREATE_TOOLKIT
      example: READ
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    CreatePaaSDatabaseConnectorParameters:
      description: Parameters to create a PaaS Database compliance connector.
      type: object
      required:
      - engine_id
      - schema_name
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 256
        masking_environment_id:
          type: string
          minLength: 1
          maxLength: 256
        schema_name:
          type: string
          minLength: 1
          maxLength: 2048
        username:
          description: The username this Connector will use to connect to the database.
          type: string
        password:
          x-dct-toolkit-credential-field: true
          description: The password this Connector will use to connect to the database.
          type: string
    PaaSDatabase:
      description: A PaaS Database.
      type: object
      properties:
        id:
          description: The PaaS Database object entity ID.
          type: string
          example: db-123
        name:
          description: The PaaS Database name.
          type: string
          example: my-db-123
        plugin_id:
          description: Id of the PaaS plugin which manages this Database.
          type: string
          example: plugin-123
        is_snapshot_operation_target:
          description: Whether this PaaS Database can be the target of a DCT snapshot operation.
          type: boolean
        instance_id:
          description: Id of the PaaS Instance of this Database.
          type: string
          example: instance-123
        instance_name:
          description: Name of the PaaS Instance of this Database.
          type: string
          example: my-instance-123
        cloud_account_id:
          description: Id of the Cloud Account to which this Database belongs.
          type: string
          example: environment-123
        cloud_account_name:
          description: Name of the Cloud Account to which this Database belongs.
          type: string
          example: AWS-US-EAST-1
        database_engine:
          description: Name of the database engine.
          type: string
          example: Azure SQL Server
        database_engine_version:
          description: Version of the database engine.
          type: string
          example: 19.1.2
        status:
          description: The management status of this PaaS Database. DISCOVERED means the database has been found by DCT but is not yet under DCT management. DCT_MANAGED means the database is actively managed by DCT. ROOT means the database serves as the root source for DCT-managed child databases.
          type: string
          enum:
          - DISCOVERED
          - DCT_MANAGED
          - ROOT
        runtime_status:
          description: Runtime status of the PaaS Database.
          type: string
          enum:
          - CREATING
          - FAILED
          - RUNNING
          - DEPROVISIONED
          - STOPPED
          - DELETED_ROOT_SOURCE
          - REFRESHING
        connection_strings:
          description: Connection strings (such as JDBC URLs) for applications to connect to the database.
          type: array
          items:
            type: string
        parent_database_id:
          description: The ID of the parent PaaS Database, if this is a child database.
          type: string
          example: my-db-123
        parent_database_name:
          description: The name of the parent PaaS Database, if this is a child database.
          type: string
          example: my-parent-db
        root_database_id:
          description: The ID of the root PaaS Database, if this is a managed database.
          type: string
          example: my-root-123
        root_database_name:
          description: The name of the root PaaS Database, if this is a managed database.
          type: string
          example: my-root-db
        parent_snapshot_id:
          description: The ID of the parent PaaS Snapshot, if this is a child database.
          type: strin

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