Content Filter Rules

Get Content Filter Rules

get

Get all Content Filter Rules in a configuration

Path parameters
configstringRequired
Responses
200

Content Filter Rules retrieved successfully

application/json
get
/api/v4.0/conf/{config}/content-filter-rules
GET /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "category": "text",
      "description": "",
      "id": "text",
      "msg": "text",
      "name": "text",
      "operand": "text",
      "risk": 1,
      "subcategory": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Modify Content Filter Rules

put

Update an existing set of Content Filter Rules for a configuration

Path parameters
configstringRequired
Bodyobject · ContentFilterRule[]
categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""
stringOptional
or
nullOptional
idstringRequired
msgstringRequired

Log message for this rule

namestring · min: 1Required
operandstring · min: 1Required

Matching domain(s) regex

riskinteger · min: 1 · max: 5Required

Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)

subcategorystringRequired

Subcategory of the rule

tagsstring[]Optional

List of tags to apply

Default: []
Responses
200

Content Filter Rules updated successfully

application/json
put
/api/v4.0/conf/{config}/content-filter-rules
PUT /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 140

[
  {
    "category": "text",
    "description": "",
    "id": "text",
    "msg": "text",
    "name": "text",
    "operand": "text",
    "risk": 1,
    "subcategory": "text",
    "tags": [
      "text"
    ]
  }
]
{
  "message": "Successfully updated entry"
}

Create Content Filter Rules

post

Create a complete set of Content Filter Rules for a configuration

Path parameters
configstringRequired
Bodyobject · ContentFilterRule[]
categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""
stringOptional
or
nullOptional
idstringRequired
msgstringRequired

Log message for this rule

namestring · min: 1Required
operandstring · min: 1Required

Matching domain(s) regex

riskinteger · min: 1 · max: 5Required

Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)

subcategorystringRequired

Subcategory of the rule

tagsstring[]Optional

List of tags to apply

Default: []
Responses
201

Content Filter Rules created successfully

application/json
post
/api/v4.0/conf/{config}/content-filter-rules
POST /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 140

[
  {
    "category": "text",
    "description": "",
    "id": "text",
    "msg": "text",
    "name": "text",
    "operand": "text",
    "risk": 1,
    "subcategory": "text",
    "tags": [
      "text"
    ]
  }
]
{
  "message": "Successfully created entry"
}

Delete Content Filter Rules

delete

Delete all Content Filter Rules in a configuration

Path parameters
configstringRequired
Responses
200

Content Filter Rules deleted successfully

application/json
delete
/api/v4.0/conf/{config}/content-filter-rules
DELETE /api/v4.0/conf/{config}/content-filter-rules HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get single Content Filter Rule

get

Get a Content Filter Rule from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Content Filter Rule retrieved successfully

application/json
get
/api/v4.0/conf/{config}/content-filter-rules/{entry_id}
GET /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "category": "text",
  "description": "",
  "id": "text",
  "msg": "text",
  "name": "text",
  "operand": "text",
  "risk": 1,
  "subcategory": "text",
  "tags": [
    "text"
  ]
}

Modify a single Content Filter Rule

put

Update an individual Content Filter Rule within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""
stringOptional
or
nullOptional
idstringRequired
msgstringRequired

Log message for this rule

namestring · min: 1Required
operandstring · min: 1Required

Matching domain(s) regex

riskinteger · min: 1 · max: 5Required

Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)

subcategorystringRequired

Subcategory of the rule

tagsstring[]Optional

List of tags to apply

Default: []
Responses
200

Content Filter Rule updated successfully

application/json
put
/api/v4.0/conf/{config}/content-filter-rules/{entry_id}
PUT /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "category": "text",
  "description": "",
  "id": "text",
  "msg": "text",
  "name": "text",
  "operand": "text",
  "risk": 1,
  "subcategory": "text",
  "tags": [
    "text"
  ]
}
{
  "message": "Successfully updated entry"
}

Create single Content Filter Rule

post

Create an individual Content Filter Rule within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""
stringOptional
or
nullOptional
idstringRequired
msgstringRequired

Log message for this rule

namestring · min: 1Required
operandstring · min: 1Required

Matching domain(s) regex

riskinteger · min: 1 · max: 5Required

Risk level of this rule, between 1 (lowest risk) and 5 (highest risk)

subcategorystringRequired

Subcategory of the rule

tagsstring[]Optional

List of tags to apply

Default: []
Responses
201

Content Filter Rule created successfully

application/json
post
/api/v4.0/conf/{config}/content-filter-rules/{entry_id}
POST /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "category": "text",
  "description": "",
  "id": "text",
  "msg": "text",
  "name": "text",
  "operand": "text",
  "risk": 1,
  "subcategory": "text",
  "tags": [
    "text"
  ]
}
{
  "message": "Successfully created entry"
}

Delete single Content Filter Rule

delete

Delete an individual Content Filter Rule from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Content Filter Rule deleted successfully

application/json
delete
/api/v4.0/conf/{config}/content-filter-rules/{entry_id}
DELETE /api/v4.0/conf/{config}/content-filter-rules/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Content Filter Rules version list

get

Get list of versions of Content Filter Rules in a configuration

Path parameters
configstringRequired
Responses
200

Content Filter Rules version list retrieved successfully

application/json
get
/api/v4.0/conf/{config}/content-filter-rules/versions
GET /api/v4.0/conf/{config}/content-filter-rules/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[email protected]",
      "message": "text",
      "date": "2025-11-04T03:29:41.317Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Content Filter Rule set

get

Get a specific version of a Content Filter Rule set

Path parameters
configstringRequired
versionstringRequired
Responses
200

Content Filter Rule set retrieved successfully

application/json
get
/api/v4.0/conf/{config}/content-filter-rules/versions/{version}
GET /api/v4.0/conf/{config}/content-filter-rules/versions/{version} HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "category": "text",
      "description": "",
      "id": "text",
      "msg": "text",
      "name": "text",
      "operand": "text",
      "risk": 1,
      "subcategory": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Revert a Content Filter Rule to the specified version

put

Set a previous Content Filter Rule version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200

Content Filter Rule reversion was successful

application/json
put
/api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert
PUT /api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousContent Filter ProfilesNextData queries

Last updated

Was this helpful?