How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Delphix RuleSets API

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

Delphix RuleSets API is one of 60 APIs that Delphix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rulesets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 14 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

Requests are made against a single base URL, /dct/v3.

19 operations 14 paths 23 schemas 1 DELETE7 GET3 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.28.0
Base URL
https://help-api.delphix.com/dct/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Delphix RuleSets API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 1 DELETE, 7 GET, 3 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

RuleSets 19
POST
/rule-sets
Create a Rule Set.
create_rule_set body → 201
GET
/rule-sets
Retrieve the list of Rule Sets.
get_rule_sets 3 params → 200
POST
/rule-sets/search
Search for Rule Sets.
search_rule_sets 3 params body → 200
GET
/rule-sets/{ruleSetId}
Get a Rule Set by ID.
get_rule_set_by_id 1 param → 200
PATCH
/rule-sets/{ruleSetId}
Update a Rule Set.
update_rule_set 1 param body → 200
DELETE
/rule-sets/{ruleSetId}
Delete a Rule Set.
delete_rule_set 1 param → 200
POST
/rule-sets/{ruleSetId}/refresh
Refresh a Rule Set.
refresh_rule_set 1 param → 200
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.
bulk_table_delta_update_rule_set 1 param body → 200
PATCH
/rule-sets/{ruleSetId}/database-table-metadata
Update multiple database table metadata objects for a rule set.
patch_database_table_metadata_for_rule_set 1 param body → 200400404
GET
/rule-sets/{ruleSetId}/tags
Get tags for a Rule Set.
get_rule_set_tags 1 param → 200
POST
/rule-sets/{ruleSetId}/tags
Create tags for a Rule Set.
create_rule_set_tags 1 param body → 201
POST
/rule-sets/{ruleSetId}/tags/delete
Delete tags for a Rule Set.
delete_rule_set_tags 1 param body → 204
GET
/database-table-metadata
Retrieve table metadata.
get_database_table_metadata 3 params → 200
POST
/database-table-metadata/search
Search table metadata.
search_database_table_metadata 3 params body → 200
GET
/database-table-metadata/{databaseTableMetadataId}
Retrieve a database table metadata by ID.
get_database_table_metadata_by_id 1 param → 200
GET
/database-column-metadata
Retrieve column metadata.
get_database_column_metadata 3 params → 200
POST
/database-column-metadata/search
Search column metadata.
search_database_column_metadata 3 params body → 200
GET
/database-column-metadata/{databaseColumnMetadataId}
Retrieve a database column metadata by ID.
get_database_column_metadata_by_id 1 param → 200
PATCH
/database-column-metadata/{databaseColumnMetadataId}
Update a database column metadata
update_database_column_metadata 1 param body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are DatabaseColumnMetadata (28 properties), Job (25 properties), DatabaseTableMetadata (23 properties), RuleSet (23 properties). Each schema is shown below with its type and property counts.

ConnectorTypeEnum
string
DatabaseTableMetadataParameters
object
An object describe a database table of a rule set with some settings.
5 properties 1 required
Tag
object
2 properties 2 required
RuleSetUpdateRequest
object
Parameters used to update a rule set.
2 properties
DatabaseTableMetadataUpdateParameters
object
Parameters to update a database table metadata object. Fields not provided are left unchanged (subject to HyperscaleInstance backfill when applicable).
13 properties 1 required
VirtualizationTaskEvent
object
1 property
Engine
object
2 properties
DatabaseColumnMetadata
object
An object describing a database column metadata with some settings.
28 properties
PaginatedResponseMetadata
object
3 properties
RuleSet
object
A masking rule set.
23 properties
JobTaskEvent
object
1 property
DatabaseTableMetadataBulkPatchRequest
object
A request to update multiple database table metadata objects for a rule set.
2 properties
RuleSetCreateRequest
object
Parameters used to create a rule set.
5 properties 2 required
DeleteTag
object
3 properties
JobTask
object
8 properties
TagsRequest
object
1 property 1 required
SearchBody
object
Search body.
1 property
VirtualizationTask
object
8 properties
TagsResponse
object
1 property
DatabaseColumnMetadataUpdateRequest
object
Parameters to update a database column metadata.
7 properties
DatabaseTableMetadata
object
An object describe a database table of a rule set with some settings.
23 properties
Job
object
An asynchronous task.
25 properties
RuleSetBulkTableDeltaUpdateRequest
object
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 n…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-rulesets-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

Delphix Algorithms API
Delphix Bookmarks API
Delphix CDB DSources API
Delphix CDBs API
Delphix Classifiers API
Delphix CloudAccounts API
Delphix ComplianceJobCollections API
Delphix ComplianceJobs API
Delphix ComplianceNodes API
Delphix Connectivity API
Delphix Connectors API
Delphix DatabaseTemplates API
Where this information came from

This is an independent, third-party profile of Delphix RuleSets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.