POST
/
datamasking-rules
Create Data Masking Rule
curl --request POST \
  --url https://use.hoop.dev/api/datamasking-rules \
  --header 'Content-Type: application/json' \
  --data '{
  "connection_ids": [
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
  ],
  "custom_entity_types": [
    {
      "deny_list": [
        "Mr",
        "Mr.",
        "Mister"
      ],
      "name": "ZIP_CODE",
      "regex": "\\b\\d{5}(?:-\\d{4})?\\b",
      "score": 0.01
    }
  ],
  "description": "Mask email addresses in the data",
  "name": "mask-email",
  "score_threshold": 0.6,
  "supported_entity_types": [
    {
      "entity_types": [
        "EMAIL_ADDRESS",
        "PERSON",
        "PHONE_NUMBER",
        "IP_ADDRESS"
      ],
      "name": "PII"
    }
  ]
}'
{
  "connection_ids": [
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
  ],
  "custom_entity_types": [
    {
      "deny_list": [
        "Mr",
        "Mr.",
        "Mister"
      ],
      "name": "ZIP_CODE",
      "regex": "\\b\\d{5}(?:-\\d{4})?\\b",
      "score": 0.01
    }
  ],
  "description": "Mask email addresses in the data",
  "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "name": "mask-email",
  "score_threshold": 0.6,
  "supported_entity_types": [
    {
      "entity_types": [
        "EMAIL_ADDRESS",
        "PERSON",
        "PHONE_NUMBER",
        "IP_ADDRESS"
      ],
      "name": "PII"
    }
  ],
  "updated_at": "2023-08-15T14:30:45Z"
}

Body

application/json

The request body resource

​
name
string
required

The unique name of the data masking rule, it's immutable after creation

Example:

"mask-email"

​
connection_ids
string[]

The connections that this rule applies to

Example:
[
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
]
​
custom_entity_types
object[]

The custom entity types that this rule applies to

​
description
string

The description of the data masking rule

Example:

"Mask email addresses in the data"

​
score_threshold
number

The minimal detection score threshold for the entities to be masked.

Example:

0.6

​
supported_entity_types
object[]

The registered entity types that this rule applies to

Response

Created

​
name
string
required

The unique name of the data masking rule, it's immutable after creation

Example:

"mask-email"

​
connection_ids
string[]

The connections that this rule applies to

Example:
[
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
]
​
custom_entity_types
object[]

The custom entity types that this rule applies to

​
description
string

The description of the data masking rule

Example:

"Mask email addresses in the data"

​
id
string<uuid>

The unique identifier of the data masking rule

Example:

"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"

​
score_threshold
number

The minimal detection score threshold for the entities to be masked.

Example:

0.6

​
supported_entity_types
object[]

The registered entity types that this rule applies to

​
updated_at
string

The timestamp when the rule was updated

Example:

"2023-08-15T14:30:45Z"