Get DLP Rule

Return a DLP rule, seeded or custom.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

rule_idstringRequiredformat: "uuid"

The rule’s id.

Response

The DLP rule

actionenum

log records a match and sends the prompt unchanged, redact replaces each match with a placeholder such as <US_SSN> before the prompt is sent, and block refuses the request with 422.

Allowed values:

categoryenumRead-only

custom for rules the organization creates; global and usa are seeded.

Allowed values:

created_atdatetimeRead-only

For a seeded rule never changed, the time of the request.

descriptionstring

What the rule detects.

detection_methodstringRead-only

How the rule finds matches, like Pattern match and checksum.

display_namestringRead-only

The name the dashboard shows.

enabledboolean

Whether the rule scans requests.

entity_typestring

The rule's name. Unique among the organization's custom rules.

idstringRead-onlyformat: "uuid"

Stable for seeded rules, even before they are first changed.

is_seededbooleanRead-only

Seeded rules can't be created or deleted, only enabled and given an action.

keywordslist of strings or null

Words the rule matches, if it has any.

patternstring or null

The rule's regular expression, if it has one.

updated_atdatetimeRead-only

When the rule last changed.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error