Skip to main content

runtime dlp profiles

runtime dlp profiles list

List data profiles

airs runtime dlp profiles list [options]

Options

FlagRequiredDefaultDescription
--limit <n>NoMax results per page (API page size)
--offset <n>NoStarting offset — rounds down to a page boundary
--sort <field,dir>NoSort criteria (repeatable)
--output <fmt>NoprettyOutput format

Examples

Pretty output (default — DLP profiles list has no custom renderer, so pretty == JSON)

airs runtime dlp profiles list --limit 2 --sort id,asc
{
"content": [
{
"id": "00000001",
"name": "Bulk CCN",
"description": "Default profile for Bulk CCN",
"tenant_id": "<tenant-id>",
"type": "predefined",
"profile_status": "active",
"profile_type": "basic",
"is_granular_data_profile": false,
"is_parent_managed": false,
"version": 1,
"advance_data_patterns_rule_request": null,
"detection_rules": null,
"audit_metadata": {
"created_at": 1761657319421,
"created_by": "System",
"updated_at": 1761657319421,
"updated_by": "System"
}
},
{
"id": "00000002",
"name": "CCPA",
"description": "Default profile for CCPA",
"tenant_id": "<tenant-id>",
"type": "predefined",
"profile_status": "active",
"profile_type": "advanced",
"is_granular_data_profile": false,
"is_parent_managed": false,
"version": 1,
"advance_data_patterns_rule_request": [
"(Tax Id - US - TIN high more_than_equal_to 1) or (Credit Card Number high more_than_equal_to 1 and Magnetic Stripe Information high more_than_equal_to 1) or (National Id - US Social Security Number - SSN high more_than_equal_to 1)"
],
"detection_rules": null,
"audit_metadata": {
"created_at": 1761657319427,
"created_by": "System",
"updated_at": 1761657319427,
"updated_by": "System"
}
}
],
"page": {
"number": 0,
"size": 2,
"total_pages": 15,
"total_elements": 30,
"number_of_elements": 2,
"first": true,
"last": false,
"empty": false
}
}

JSON output

airs runtime dlp profiles list --limit 2 --sort id,asc --output json
{
"content": [
{
"id": "00000001",
"name": "Bulk CCN",
"description": "Default profile for Bulk CCN",
"tenant_id": "<tenant-id>",
"type": "predefined",
"profile_status": "active",
"profile_type": "basic",
"is_granular_data_profile": false,
"is_parent_managed": false,
"version": 1,
"advance_data_patterns_rule_request": null,
"detection_rules": null,
"audit_metadata": {
"created_at": 1761657319421,
"created_by": "System",
"updated_at": 1761657319421,
"updated_by": "System"
}
},
{
"id": "00000002",
"name": "CCPA",
"description": "Default profile for CCPA",
"tenant_id": "<tenant-id>",
"type": "predefined",
"profile_status": "active",
"profile_type": "advanced",
"is_granular_data_profile": false,
"is_parent_managed": false,
"version": 1,
"advance_data_patterns_rule_request": [
"(Tax Id - US - TIN high more_than_equal_to 1) or (Credit Card Number high more_than_equal_to 1 and Magnetic Stripe Information high more_than_equal_to 1) or (National Id - US Social Security Number - SSN high more_than_equal_to 1)"
],
"detection_rules": null,
"audit_metadata": {
"created_at": 1761657319427,
"created_by": "System",
"updated_at": 1761657319427,
"updated_by": "System"
}
}
],
"page": {
"number": 0,
"size": 2,
"total_pages": 15,
"total_elements": 30,
"number_of_elements": 2,
"first": true,
"last": false,
"empty": false
}
}

YAML output

airs runtime dlp profiles list --limit 2 --sort id,asc --output yaml
content:
- id: '00000001'
name: Bulk CCN
description: Default profile for Bulk CCN
tenant_id: <tenant-id>
type: predefined
profile_status: active
profile_type: basic
is_granular_data_profile: false
is_parent_managed: false
version: 1
advance_data_patterns_rule_request: null
detection_rules: null
audit_metadata:
created_at: 1761657319421
created_by: System
updated_at: 1761657319421
updated_by: System
- id: '00000002'
name: CCPA
description: Default profile for CCPA
tenant_id: <tenant-id>
type: predefined
profile_status: active
profile_type: advanced
is_granular_data_profile: false
is_parent_managed: false
version: 1
advance_data_patterns_rule_request:
- >-
(Tax Id - US - TIN high more_than_equal_to 1) or (Credit Card
Number high more_than_equal_to 1 and Magnetic Stripe Information
high more_than_equal_to 1) or (National Id - US Social Security
Number - SSN high more_than_equal_to 1)
detection_rules: null
audit_metadata:
created_at: 1761657319427
created_by: System
updated_at: 1761657319427
updated_by: System
page:
number: 0
size: 2
total_pages: 15
total_elements: 30
number_of_elements: 2
first: true
last: false
empty: false

runtime dlp profiles create

Create a data profile

airs runtime dlp profiles create [options]

Options

FlagRequiredDefaultDescription
--name <s>NoProfile name (required unless --body-file)
--profile-type <s>NoProfile type: basic
--description <s>NoDescription
--granularNoGranular data profile
--pattern-id <id>NoData pattern ID to include (repeatable). Builds a simple expression_tree.
--combinator <op>NoCombinator for --pattern-id: or
--confidence <level>NoConfidence level for --pattern-id leaves (default: high)
`--body <json->`No
--body-file <path>NoRaw JSON body file (escape hatch; required for complex rule trees)
--output <fmt>NoprettyOutput format

Examples

Create a custom advanced profile from a body fixture (see docs/cli/examples/dlp/profiles/create.json). Body uses the discriminated-union detection_rules shape (rule_type=expression_tree).

airs runtime dlp profiles create --body-file docs/cli/examples/dlp/profiles/create.json --output json
{
"action": "created",
"id": "00000099",
"name": "docs-example-profile",
"type": "custom",
"status": "active",
"version": 1
}

runtime dlp profiles get

Get a data profile by id

airs runtime dlp profiles get [options] <id>

Arguments

  • id (required) —

Options

FlagRequiredDefaultDescription
--output <fmt>NoprettyOutput format

Examples

Pretty output (default — predefined profile)

airs runtime dlp profiles get 00000001
Data Profile:

ID 00000001
Name Bulk CCN
Description Default profile for Bulk CCN
Type predefined
Profile Type basic
Status active
Version 1
Updated 2026-05-15T08:05:35.599Z

JSON output

airs runtime dlp profiles get 00000001 --output json
{
"id": "00000001",
"name": "Bulk CCN",
"description": "Default profile for Bulk CCN",
"type": "predefined",
"profile_type": "basic",
"status": "active",
"version": 1,
"updated": "2026-05-15T08:05:35.599Z"
}

YAML output

airs runtime dlp profiles get 00000001 --output yaml
id: '00000001'
name: Bulk CCN
description: Default profile for Bulk CCN
type: predefined
profile_type: basic
status: active
version: 1
updated: '2026-05-15T08:05:35.599Z'

runtime dlp profiles replace

Full-replace a data profile (PUT)

airs runtime dlp profiles replace [options] <id>

Arguments

  • id (required) —

Options

FlagRequiredDefaultDescription
--name <s>NoProfile name (required unless --body-file)
--profile-type <s>NoProfile type: basic
--description <s>NoDescription
--granularNoGranular data profile
--pattern-id <id>NoData pattern ID to include (repeatable). Builds a simple expression_tree.
--combinator <op>NoCombinator for --pattern-id: or
--confidence <level>NoConfidence level for --pattern-id leaves (default: high)
`--body <json->`No
--body-file <path>NoRaw JSON body file (escape hatch; required for complex rule trees)
--output <fmt>NoprettyOutput format

Examples

Example needed

No curated input/output example for this command yet.


runtime dlp profiles patch

JSON Merge Patch. body must include name + profile_type. Use --body-file for nested fields. --set/--clear coerce values: numbers/booleans/JSON literals. To force a string, quote: --set count='"5"'.

airs runtime dlp profiles patch [options] <id>

Arguments

  • id (required) —

Options

FlagRequiredDefaultDescription
--body-file <path>NoJSON merge-patch body file
--set <k=v...>NoSet scalar field (repeatable)
--clear <key...>NoClear field via merge-patch null (repeatable)
--output <fmt>NoprettyOutput format

Examples

Example needed

No curated input/output example for this command yet.


runtime dlp profiles delete

Not supported — prints the patch idiom and exits 2

airs runtime dlp profiles delete [options] <id>

Arguments

  • id (required) —

Examples

Stub — DLP data profiles have no DELETE endpoint; soft-delete via patch

airs runtime dlp profiles delete 00000001
This DLP API has no DELETE for data profiles.
To soft-delete, fetch the profile to get its name + profile_type, then patch:

airs runtime dlp profiles get 00000001 --output json
airs runtime dlp profiles patch 00000001 --set profile_status='"deleted"' \
--set name='"<existing-name>"' --set profile_type='"<existing-type>"'