Skip to content

List Built-In Patterns


In previous documentation, rule and pattern is referred to as classifier or identifier and framework as template. The language is being updated to rule to be more accurate and not conflate meaning with other Immuta features.


Attributes of rules and frameworks are provided on the Sensitive data discovery API page. However, attributes specific to listing rules, and their patterns, are outlined in the table below.

Attribute Description
sortField string The field by which to sort the search results: id, name, displayName, type, createdAt, or updatedAt.
sortOrder string Denotes whether to sort the results in ascending (asc) or descending (desc) order. Default is asc.
offSet integer Use in combination with limit to fetch pages.
limit integer Limits the number of results displayed per page.
type array[string] Searches for rules based on type: builtIn.
searchText string A partial, case-insensitive search on name.

Response details

The response lists all built-in patterns that are currently supported in Immuta SDD and their details, including their name and description. For example,

  "count": 67,
  "hits": [
      "createdBy": {
        "id": 21,
        "name": "Immuta System Account",
        "email": ""
      "name": "AGE",
      "displayName": "Age",
      "description": "Detects numeric strings between 10 and 199.",
      "type": "builtIn",
      "config": {
        "minConfidence": 0.7,
        "tags": [
          "Discovered.Identifier Indirect",
        "conditionalTags": {}
      "id": 3,
      "createdAt": "2021-10-28T07:34:58.761Z",
      "updatedAt": "2021-10-28T07:34:58.761Z"

List built-in patterns

  1. Generate your API key on the API Keys tab on your profile page and save the API key somewhere secure. You will include this API key in the authorization header when you make a request to the Immuta API or use it to configure your instance with the Immuta CLI.

  2. List built-in patterns using one of these methods:

    Immuta CLI

    immuta api sdd/classifier?sortField=name&sortOrder=asc&limit=100&type=builtIn


    curl \
        --request GET \
        --header "Content-Type: application/json" \
        --header "Authorization: 12345678900000" \

If the request was successful, you will receive a list of built-in patterns.

What's next