Skip to content

Get a Rule Set by ID.

Request

Security
ApiKeyAuth
Path
ruleSetIdstring, non-emptyrequired

The ID of the Rule Set.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/2025.4.0.0/continuous-compliance-apis-dct-2025.4.0.0/rule-sets/{ruleSetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

The rule set ID.

Example:"a638d976-6b7e-43f4-9212-90f4dc6d405c"
namestring

The name of this rule set.

typestring or null(ConnectorTypeEnum)

The rule set connector type.

Enum:"DATABASE""FILE""MAINFRAME_DATASET"
Example:"DATABASE"
platformstring or null

The rule set connector platform.

Example:"Oracle"
connector_idstring or null

The ID of the connector this rule set uses.

connector_namestring or null

The name of the connector this rule set uses.

engine_idstring or null

The ID of the engine this rule set originated from.

engine_namestring or null

The name of the engine this rule set originated from.

data_elements_totalinteger or null, (int64)

The total number of data elements in this rule set.

data_elements_sensitiveinteger or null, (int64)

The number of sensitive data elements in this rule set.

records_totalinteger or null, (int64)

The total number of records in this rule set.

records_sensitiveinteger or null, (int64)

The number of sensitive records in this rule set.

creation_datestring, (date-time)read-only

The date this rule set was created.

Example:"2022-11-30T08:51:34.148000+00:00"
account_idinteger, (int64)read-only

The ID of the account who created this rule set.

Example:1
account_namestringread-only

The username of the account who created this rule set.

Example:"John Doe"
dct_managedbooleanread-only

Whether or not this rule set is managed by DCT.

refresh_drops_tablesboolean

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.

Example:false
tagsArray of objects(Tag)

The tags of this rule set.

job_orchestrator_idstringread-only
job_orchestrator_namestringread-only
Response
{ "id": "a638d976-6b7e-43f4-9212-90f4dc6d405c", "name": "string", "type": "DATABASE", "platform": "Oracle", "connector_id": "string", "connector_name": "string", "engine_id": "string", "engine_name": "string", "data_elements_total": 0, "data_elements_sensitive": 0, "records_total": 0, "records_sensitive": 0, "creation_date": "2022-11-30T08:51:34.148000+00:00", "account_id": 1, "account_name": "John Doe", "dct_managed": true, "refresh_drops_tables": false, "tags": [ { … } ], "job_orchestrator_id": "string", "job_orchestrator_name": "string" }