Delphix

Delphix RuleSets API

The RuleSets API from Delphix — 14 operation(s) for rulesets.

GitHub OpenAPI

Operations 19

POST /rule-sets Create a Rule Set. #
GET /rule-sets Retrieve the list of Rule Sets. #
POST /rule-sets/search Search for Rule Sets. #
GET /rule-sets/{ruleSetId} Get a Rule Set by ID. #
PATCH /rule-sets/{ruleSetId} Update a Rule Set. #
DELETE /rule-sets/{ruleSetId} Delete a Rule Set. #
POST /rule-sets/{ruleSetId}/refresh Refresh a Rule Set. #
POST /rule-sets/{ruleSetId}/bulk-table-delta-update Update the set of tables and their attributes associated with a database rule set in bulk in a delta fashion. #
PATCH /rule-sets/{ruleSetId}/database-table-metadata Update multiple database table metadata objects for a rule set. #
GET /rule-sets/{ruleSetId}/tags Get tags for a Rule Set. #
POST /rule-sets/{ruleSetId}/tags Create tags for a Rule Set. #
POST /rule-sets/{ruleSetId}/tags/delete Delete tags for a Rule Set. #
GET /database-table-metadata Retrieve table metadata. #
POST /database-table-metadata/search Search table metadata. #
GET /database-table-metadata/{databaseTableMetadataId} Retrieve a database table metadata by ID. #
GET /database-column-metadata Retrieve column metadata. #
POST /database-column-metadata/search Search column metadata. #
GET /database-column-metadata/{databaseColumnMetadataId} Retrieve a database column metadata by ID. #
PATCH /database-column-metadata/{databaseColumnMetadataId} Update a database column metadata #

Documentation

📖
Documentation
https://dct.delphix.com/docs/latest/api-references
📖
APIReference
https://help-api.delphix.com/data-control-tower/continuous-data/2026.3.0.0/continuous-data-apis-dct-2026.3.0.0.html
📖
APIReference
https://help-api.delphix.com/data-control-tower/continuous-compliance/2026.3.0.0/continuous-compliance-apis-dct-2026.3.0.0.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-rulesets-api-openapi.yml

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-rulesets-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.

GitHub Google LinkedIn

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

OpenAPI Specification

delphix-rulesets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Delphix DCT Algorithms Rule Sets 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: RuleSets
paths:
  /rule-sets:
    post:
      tags:
      - RuleSets
      summary: Create a Rule Set.
      operationId: create_rule_set
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: rule_set_create_request
              $ref: '#/components/schemas/RuleSetCreateRequest'
        required: true
      responses:
        '201':
          description: Rule Set creation initiated.
          content:
            application/json:
              schema:
                type: object
                title: RuleSetCreateResponse
                properties:
                  id:
                    type: string
                    description: The ID of the created rule set.
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    get:
      tags:
      - RuleSets
      summary: Retrieve the list of Rule Sets.
      operationId: get_rule_sets
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/ruleSetsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RuleSetsListResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/RuleSet'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /rule-sets/search:
    post:
      tags:
      - RuleSets
      summary: Search for Rule Sets.
      operationId: search_rule_sets
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          type:
            type: string
          platform:
            type: string
          connector_id:
            type: string
          connector_name:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          data_elements_total:
            type: integer
          data_elements_sensitive:
            type: integer
          records_total:
            type: integer
          records_sensitive:
            type: integer
          creation_date:
            type: string
          account_id:
            type: integer
          account_name:
            type: string
          dct_managed:
            type: boolean
          job_orchestrator_id:
            type: string
          job_orchestrator_name:
            type: string
          last_attempted_refresh_status:
            type: string
          last_attempted_refresh_time:
            type: string
          last_refresh_time:
            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/ruleSetsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RuleSetsSearchResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/RuleSet'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /rule-sets/{ruleSetId}:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    get:
      tags:
      - RuleSets
      summary: Get a Rule Set by ID.
      operationId: get_rule_set_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSet'
    patch:
      tags:
      - RuleSets
      summary: Update a Rule Set.
      operationId: update_rule_set
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: rule_set_update_request
              $ref: '#/components/schemas/RuleSetUpdateRequest'
        required: true
      responses:
        '200':
          description: Rule Set update initiated.
          content:
            application/json:
              schema:
                type: object
                title: RuleSetUpdateResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
    delete:
      tags:
      - RuleSets
      summary: Delete a Rule Set.
      operationId: delete_rule_set
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RuleSetDeleteResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The completed job.
  /rule-sets/{ruleSetId}/refresh:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    post:
      tags:
      - RuleSets
      summary: Refresh a Rule Set.
      operationId: refresh_rule_set
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RefreshRuleSetResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The completed job.
  /rule-sets/{ruleSetId}/bulk-table-delta-update:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    post:
      tags:
      - RuleSets
      summary: Update the set of tables and their attributes associated with a database rule set in bulk in a delta fashion.
      operationId: bulk_table_delta_update_rule_set
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: rule_set_bulk_table_delta_update_request
              $ref: '#/components/schemas/RuleSetBulkTableDeltaUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: RuleSetBulkTableDeltaUpdateResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The completed job.
  /rule-sets/{ruleSetId}/database-table-metadata:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    patch:
      tags:
      - RuleSets
      summary: Update multiple database table metadata objects for a rule set.
      operationId: patch_database_table_metadata_for_rule_set
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: database_table_metadata_patch_request
              $ref: '#/components/schemas/DatabaseTableMetadataBulkPatchRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DatabaseTableMetadataBulkPatchResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
        '400':
          description: Invalid request (e.g. duplicate table names or table not found).
        '404':
          description: Rule set not found.
  /rule-sets/{ruleSetId}/tags:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    get:
      tags:
      - RuleSets
      summary: Get tags for a Rule Set.
      operationId: get_rule_set_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    post:
      tags:
      - RuleSets
      summary: Create tags for a Rule Set.
      operationId: create_rule_set_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: rule_set_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Rule Set.
        required: true
      responses:
        '201':
          description: Rule Set tags created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /rule-sets/{ruleSetId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/ruleSetIdParam'
    post:
      tags:
      - RuleSets
      summary: Delete tags for a Rule Set.
      operationId: delete_rule_set_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /database-table-metadata:
    get:
      tags:
      - RuleSets
      summary: Retrieve table metadata.
      operationId: get_database_table_metadata
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/databaseTableMetadataSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DatabaseTableMetadataListResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseTableMetadata'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /database-table-metadata/search:
    post:
      tags:
      - RuleSets
      summary: Search table metadata.
      operationId: search_database_table_metadata
      x-filterable:
        fields:
          id:
            type: string
          table_name:
            type: string
          rule_set_id:
            type: string
          rule_set_name:
            type: string
          custom_sql:
            type: string
          where_clause:
            type: string
          having_clause:
            type: string
          key_column:
            type: string
          is_sensitive:
            type: boolean
          row_count:
            type: integer
          last_refresh_time:
            type: string
          last_row_count_time:
            type: string
          filter_key:
            type: string
          unload_split:
            type: integer
          auto_calculate_unload_split:
            type: boolean
          max_parallel_connections_per_table:
            type: integer
          max_records_per_split:
            type: integer
          max_split_per_connection:
            type: integer
          stream_size:
            type: integer
          column_array_rows:
            type: integer
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/databaseTableMetadataSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DatabaseTableMetadataSearchResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseTableMetadata'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /database-table-metadata/{databaseTableMetadataId}:
    parameters:
    - $ref: '#/components/parameters/databaseTableMetadataIdParam'
    get:
      tags:
      - RuleSets
      summary: Retrieve a database table metadata by ID.
      operationId: get_database_table_metadata_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseTableMetadata'
  /database-column-metadata:
    get:
      tags:
      - RuleSets
      summary: Retrieve column metadata.
      operationId: get_database_column_metadata
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/databaseColumnMetadataSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DatabaseColumnMetadataListResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseColumnMetadata'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /database-column-metadata/search:
    post:
      tags:
      - RuleSets
      summary: Search column metadata.
      operationId: search_database_column_metadata
      x-filterable:
        fields:
          id:
            type: integer
          column_name:
            type: string
          database_table_metadata_id:
            type: integer
          table_name:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          rule_set_id:
            type: string
          rule_set_name:
            type: string
          algorithm_id:
            type: string
          algorithm_name:
            type: string
          data_class_id:
            type: string
          data_class_name:
            type: string
          data_type:
            type: string
          date_format:
            type: string
          column_length:
            type: integer
          is_sensitive:
            type: boolean
          is_profiler_writable:
            type: boolean
          is_primary_key:
            type: boolean
          is_identity:
            type: boolean
          is_index:
            type: boolean
          is_foreign_key:
            type: boolean
          document_store_type:
            type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/databaseColumnMetadataSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DatabaseColumnMetadataSearchResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseColumnMetadata'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /database-column-metadata/{databaseColumnMetadataId}:
    parameters:
    - $ref: '#/components/parameters/databaseColumnMetadataIdParam'
    get:
      tags:
      - RuleSets
      summary: Retrieve a database column metadata by ID.
      operationId: get_database_column_metadata_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseColumnMetadata'
    patch:
      tags:
      - RuleSets
      summary: Update a database column metadata
      operationId: update_database_column_metadata
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: database_column_metadata_update_request
              $ref: '#/components/schemas/DatabaseColumnMetadataUpdateRequest'
        required: true
      responses:
        '200':
          description: Database column metadata update initiated.
          content:
            application/json:
              schema:
                type: object
                title: DatabaseColumnMetadataUpdateResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
components:
  schemas:
    DatabaseTableMetadataUpdateParameters:
      x-jackson-optional-nullable-helpers: true
      description: Parameters to update a database table metadata object. Fields not provided are left unchanged (subject to HyperscaleInstance backfill when applicable).
      type: object
      required:
      - table_name
      properties:
        table_name:
          description: The name of the table, used to identify which record to update.
          type: string
          example: my table
        custom_sql:
          description: Custom SQL for the table.
          type:
          - string
          - 'null'
          x-is-jackson-optional-nullable: true
        where_clause:
          description: SQL where clause for the table.
          type:
          - string
          - 'null'
          x-is-jackson-optional-nullable: true
        having_clause:
          description: SQL having clause for the table.
          type:
          - string
          - 'null'
          x-is-jackson-optional-nullable: true
        key_column:
          description: Key Column for the table.
          type:
          - string
          - 'null'
          x-is-jackson-optional-nullable: true
        filter_key:
          description: Filter key column for the table. Only applicable for Hyperscale.
          type:
          - string
          - 'null'
          x-is-jackson-optional-nullable: true
        unload_split:
          description: Number of parallel unload splits. Only applicable for Hyperscale.
          type: integer
          minimum: 1
          maximum: 32767
          x-is-jackson-optional-nullable: true
        auto_calculate_unload_split:
          description: Whether to automatically calculate the unload split. Only applicable for Hyperscale.
          type: boolean
          x-is-jackson-optional-nullable: true
        max_parallel_connections_per_table:
          description: Maximum number of parallel connections per table. Only applicable for Hyperscale.
          type: integer
          minimum: 1
          maximum: 32767
          x-is-jackson-optional-nullable: true
        max_records_per_split:
          description: Maximum number of records per split. Only applicable for Hyperscale.
          type: integer
          format: int64
          minimum: 1
          x-is-jackson-optional-nullable: true
        max_split_per_connection:
          description: Maximum number of splits per connection. Only applicable for Hyperscale.
          type: integer
          minimum: 1
          maximum: 32767
          x-is-jackson-optional-nullable: true
        stream_size:
          description: Stream size in bytes. Only applicable for Hyperscale.
          type: integer
          format: int64
          minimum: 1
          x-is-jackson-optional-nullable: true
        column_array_rows:
          description: Number of column array rows. Only applicable for Hyperscale.
          type: integer
          format: int64
          minimum: 1
          x-is-jackson-optional-nullable: true
    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
    VirtualizationTaskEvent:
      deprecated: true
      properties:
        message_details:
          type: string
    RuleSetUpdateRequest:
      description: Parameters used to update a rule set.
      type: object
      properties:
        name:
          description: The name of this rule set.
          type: string
        refresh_drops_tables:
          description: This applies when table metadata exists in DCT, but the corresponding table no longer exists in the external database. In that event, true will cause the refresh operation to delete the invalid table metadata, whereas false will fail the refresh instead.
          type: boolean
    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"
    TagsResponse:
      type: object
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Tag:
      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
    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'
    JobTaskEvent:
      properties:
        message_details:
          type: string
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    DatabaseTableMetadataBulkPatchRequest:
      description: A request to update multiple database table metadata objects for a rule set.
      type: object
      properties:
        database_table_metadata:
          description: List of database table metadata update parameters.
          type: array
          items:
            $ref: '#/components/schemas/DatabaseTableMetadataUpdateParameters'
        set_hyperscale_defaults_for_other_objects:
          description: 'If true, apply HyperscaleInstance default values to all tables in the rule set that are NOT present in the database_table_metadata list. For tables that ARE in the payload, explicitly provided hyperscale values take effect and any unset hyperscale fields are backfilled from the HyperscaleInstance. Non-hyperscale fields are never defaulted for non-payload tables. When true, an empty or absent database_table_metadata list is allowed (all tables receive HyperscaleInstance defaults).

            '
          type: boolean
          default: false
    RuleSet:
      description: A masking rule set.
      type: object
      properties:
        id:
          description: The rule set ID.
          type: string
          example: a638d976-6b7e-43f4-9212-90f4dc6d405c
        name:
          description: The name of this rule set.
          type: string
        type:
          description: The rule set connector type.
          $ref: '#/components/schemas/ConnectorTypeEnum'
        platform:
          description: The rule set connector platform.
          type:
          - string
          - 'null'
          example: Oracle
        connector_id:
          description: The ID of the connector this rule set uses.
          type:
          - string
          - 'null'
        connector_name:
          description: The name of the connector this rule set uses.
          type:
          - string
          - 'null'
        engine_id:
          description: The ID of the engine this rule set originated from.
          type:
          - string
          - 'null'
        engine_name:
          description: The name of the engine this rule set originated from.
          type:
          - string
          - 'null'
        data_elements_total:
          description: The total number of data elements in this rule set.
          type:
          - integer
          - 'null'
          format: int64
        data_elements_sensitive:
          description: The number of sensitive data elements in this rule set.
          type:
          - integer
          - 'null'
          format: int64
        records_total:
          description: The total number of records in this rule set.
          type:
          - integer
          - 'null'
          format: int64
        records_sensitive:
          description: The number of sensitive records in this rule set.
          type:
          - integer
          - 'null'
          format: int64
        creation_date:
          description: The date this rule set was created.
          type: string
          format: date-time
          readOnly: true
          example: '2022-11-30T08:51:34.148000+00:00'
        account_id:
          description: The ID of the account who created this rule set.
          type: integer
          format: int64
          readOnly: true
          example: 1
        account_name:
          description: The username of the account who created this rule set.
          type: string
          readOnly: true
          example: John Doe
        dct_managed:
          description: Whether or not this rule set is managed by DCT.
          type: boolean
          readOnly: true
        refresh_drops_tables:
          description: This applies when table metadata exists in DCT, but the corresponding table no longer exists in the external database. In that event, true will cause the refresh operation to delete the invalid table metadata, whereas false will fail the refresh instead.
          type: boolean
          example: false
        tags:
          description: The tags of this rule set.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        job_orchestrator_id:
          type: string
          readOnly: true
        job_orchestrator_name:
          type: string
          readOnly: true
        last_attempted_refresh_status:
          description: The status of the last attempted rule set refresh.
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
        last_attempted_refresh_time:
          description: The date and time of the last attempted rule set refresh.
          type: string
          format: date-time
          readOnly: true
        last_refresh_time:
          description: The date and time of the last successful rule set refresh.
          type: string
          format: date-time
          readOnly: true
    RuleSetCreateRequest:
      description: Parameters used to create a rule set.
      type: object
      required:
      - name
      - connector_id
      properties:
        name:
          description: The name of this rule set.
          type: string
        connector_id:
          description: The ID of the connector this rule set uses.
          type: string
        refresh_drops_tables:
          description: This applies when table metadata exists in DCT, but the corresponding table no longer exists in the external database. In that event, true will cause the refresh operation to delete the invalid table metadata, whereas false will fail the refresh instead.
          type: boolean
          default: false
        make_current_account_owner:
          description: Whether the account creating this rule set must be configured as owner of it.
          type: boolean
          default: true
        tags:
          description: The tags for this rule set.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    DatabaseTableMetadataParameters:
      description: An object describe a database table of a rule set with some settings.
      type: object
      required:
      - table_name
      properties:
        table_name:
          description: The name of the table.
          type: string
          example: my table
        custom_sql:
          description: Custom SQL for the table.
          type: string
        where_clause:
          description: SQL where clause for the table.
          type: string
        having_clause:
          description: SQL having clause for the table.
          type: string
        key_column:
          description: Key Column for the table.
          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
    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
    RuleSetBulkTableDeltaUpdateRequest:
      description: The mutually exclusive list of tables to be added, modified, or removed from the ruleset must be provided in three different arrays. Note that only the delta needs to be provided, and existing tables not listed here will be left unchanged.
      type: object
      properties:
        add:
          description: Tables to add to the rule set.
          type: array
          items:
            $ref: '#/components/schemas/DatabaseTableMetadataParameters'
        update:
          description: Tables to update in the rule set. Any DatabaseTableMetadataParameters properties not provided will be set to null.
          type: array
          items:
            $ref: '#/components/schemas/DatabaseTableMetadataParameters'
        delete:
          description: Tables to delete from the rule set.
          type: array
          items:
            $ref: '#/components/schemas/DatabaseTableMetadataParameters'
    DatabaseTableMetadata:
      description: An object describe a database table of a rule set with some settings.
      type: object
      properties:
        id:
          description: The id of this table metadata.
          type: string
          minLength: 1
          example: '10'
        table_name:
          description: The name of the table.
          type: string
          example: my table
        rule_set_id:
          description: The id of the rule set that this table metadata belongs to.
          type: str

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