# Retrieve the list of Rule Sets.

Endpoint: GET /rule-sets
Version: 3.23.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies a descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The rule set ID.
    Example: a638d976-6b7e-43f4-9212-90f4dc6d405c

  - `items.name` (string)
    The name of this rule set.

  - `items.type` (string)
    Enum: "DATABASE", "FILE", "MAINFRAME_DATASET"

  - `items.platform` (string)
    The rule set connector platform.
    Example: Oracle

  - `items.connector_id` (string)
    The ID of the connector this rule set uses.

  - `items.connector_name` (string)
    The name of the connector this rule set uses.

  - `items.engine_id` (string)
    The ID of the engine this rule set originated from.

  - `items.engine_name` (string)
    The name of the engine this rule set originated from.

  - `items.data_elements_total` (integer)
    The total number of data elements in this rule set.

  - `items.data_elements_sensitive` (integer)
    The number of sensitive data elements in this rule set.

  - `items.records_total` (integer)
    The total number of records in this rule set.

  - `items.records_sensitive` (integer)
    The number of sensitive records in this rule set.

  - `items.creation_date` (string)
    The date this rule set was created.
    Example: 2022-11-30T08:51:34.148000+00:00

  - `items.account_id` (integer)
    The ID of the account who created this rule set.
    Example: 1

  - `items.account_name` (string)
    The username of the account who created this rule set.
    Example: John Doe

  - `items.dct_managed` (boolean)
    Whether or not this rule set is managed by DCT.

  - `items.refresh_drops_tables` (boolean)
    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

  - `items.tags` (array)
    The tags of this rule set.

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.job_orchestrator_id` (string)

  - `items.job_orchestrator_name` (string)

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    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.

  - `response_metadata.next_cursor` (string)
    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.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.