Content Filter Profiles
Get all Content Filter Profiles in a configuration
GET /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
}
Update an existing set of Content Filter Profiles for a configuration
""
List of tags to apply
[]
List of content types
[]
""
A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""
List of tags to apply
[]
When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
false
A seed which will be used in the masking process
List of tags to apply
[]
List of tags to apply
[]
PUT /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1562
[
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
{
"message": "Successfully updated entry"
}
Create a complete set of Content Filter Profiles for a configuration
""
List of tags to apply
[]
List of content types
[]
""
A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""
List of tags to apply
[]
When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
false
A seed which will be used in the masking process
List of tags to apply
[]
List of tags to apply
[]
POST /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1652
[
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
{
"message": "Successfully created entry"
}
Delete all Content Filter Profiles in a configuration
DELETE /api/v4.0/conf/{config}/content-filter-profiles HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get a Content Filter Profile from the specified configuration
GET /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"ignore_cf_rule_tags": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
Update an individual Content Filter Profile within a configuration
""
List of tags to apply
[]
List of content types
[]
""
A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""
List of tags to apply
[]
When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
false
A seed which will be used in the masking process
List of tags to apply
[]
List of tags to apply
[]
PUT /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1560
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
{
"message": "Successfully updated entry"
}
Create an individual Content Filter Profile within a configuration
""
List of tags to apply
[]
List of content types
[]
""
A field in a JSON that contains GraphQL query that need to be parsed. The value should be passed in JSONPath format. It supports regex for values as well.
""
List of tags to apply
[]
When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored
false
A seed which will be used in the masking process
List of tags to apply
[]
List of tags to apply
[]
POST /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1560
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
{
"message": "Successfully created entry"
}
Delete an individual Content Filter Profile from the specified configuration
DELETE /api/v4.0/conf/{config}/content-filter-profiles/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of Content Filter Profiles in a configuration
GET /api/v4.0/conf/{config}/content-filter-profiles/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-07-05T16:45:08.984Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of a Content Filter Profile
GET /api/v4.0/conf/{config}/content-filter-profiles/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"action": "",
"active": [
"text"
],
"allsections": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"args": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"content_type": [
"text"
],
"cookies": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"decoding": {
"base64": true,
"dual": false,
"html": false,
"unicode": false
},
"description": "",
"graphql_path": "",
"headers": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"id": "text",
"ignore": [
"text"
],
"ignore_alphanum": true,
"ignore_body": false,
"masking_seed": "text",
"name": "text",
"path": {
"enable_max_count": true,
"enable_max_length": true,
"max_count": 1,
"max_length": 1,
"names": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
],
"regex": [
{
"exclusions": [
"text"
],
"key": "",
"mask": false,
"reg": "",
"restrict": true
}
]
},
"report": [
"text"
],
"tags": [
"text"
]
}
]
}
Set a previous Content Filter Profile version to be the current one
PUT /api/v4.0/conf/{config}/content-filter-profiles/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?