Create a custom PII type

post

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

This creates a new custom PII type for an editable, non-active configuration version. Reference the returned customPiiId from the customPiiEntities of a PII rule on that same version. The response's Location header gives you the new custom PII type's URL.

Path Params

faiConfigId

string

required

^[0-9]+$

Identifier for the FAI configuration.

version

integer

required

Version number of the FAI configuration.

Query Params

accountSwitchKey

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

Request body for creating or updating a custom PII type. The server assigns the custom PII type identifier.

customPiiName

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. Must be unique within the configuration version.

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

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201Custom PII entity created successfully.

400Bad request. The request isn't valid, for example an id that isn't a number, a missing or out-of-range field, a value that isn't allowed, or rule settings that conflict. The detail names the field, the value sent, and what to change.

401Unauthorized.

403Forbidden. You don't have the access this operation needs, or your account isn't entitled to a feature the request uses, such as a rule, the MODIFY action, or languages. The detail says which access or entitlement to ask for.

404Not found. A resource in the URL doesn't exist: the configuration, version, custom PII type, application, access key, or activation. The detail names the missing id and where to find valid ones.

500Internal server error. Something failed on Akamai's side. Try again later. If it keeps happening, contact Akamai support with the instance value.