API
  1. Firewall for AI Configuration
  2. Custom PII types

Create a custom PII type

post
https://{hostname}/appsec/v1/fai-configurations//versions//custom-pii-types

Create a new custom PII type for a configuration version.

Path Params
string
required

Unique identifier for the FAI configuration.

integer
required

Version number of the FAI configuration.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Represents a custom personally identifiable information (PII) type definition for detecting organization-specific sensitive data patterns. Custom PII types extend beyond the platform's predefined PII entity types, such as credit cards, SSNs, and email addresses, to enable detection of proprietary or domain-specific sensitive identifiers such as employee IDs, internal account numbers, custom reference codes, or industry-specific data formats. Each custom PII type is defined using one or more regular expression patterns that match the sensitive data format. Once created, custom PII types can be referenced in PII detection rules via their customPiiId to automatically detect and optionally mask these patterns in LLM requests and responses.

string
required
length between 1 and 100
^[a-zA-Z0-9_-]+$

Uniquely identifies this custom PII type within the configuration version. This identifier is used to reference the custom PII type in PII detection rules, specifically in their customPiiEntities array. The ID must be unique across all custom PII types in the configuration version and should follow a clear naming convention for easy identification.

string
required
length between 1 and 255

The human-readable name for this custom PII type. This descriptive name helps administrators understand what type of sensitive data this definition detects. It appears in configuration management interfaces and audit logs for clarity and governance purposes.

patterns
array of strings
required
length ≥ 1

List of regular expression patterns that define how to detect this custom PII type in content. Each pattern is a regular expression string that matches the specific format of the sensitive data. Multiple patterns can be provided to account for format variations, such as with or without delimiters, and different prefix conventions. Patterns evaluate using standard regular expression syntax and should be carefully tested to balance detection accuracy with false positive rates. When multiple patterns are provided, content matching any pattern is considered a match for this custom PII type.

patterns*

A regular expression pattern to detect the custom PII type. The pattern uses standard regular expression syntax and can be optimized for the specific data format being detected. Consider edge cases, format variations, and potential false positives when designing patterns. Example patterns: EMP-[0-9]{6} for employee IDs like EMP-123456, or \b[A-Z]{3}-[0-9]{4}-[A-Z]{2}\b for custom reference codes.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 21 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 21 days ago

Did this page help you?