Content Filter Rules

PreviousContent Filter Profiles NextData queries

Last updated 5 months ago

Was this helpful?

Get Content Filter Rules

Get all Content Filter Rules in a configuration

get

/api/v4.0/conf/{config}/content-filter-rules

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/content-filter-rules'

200

422

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

Content Filter Rules retrieved successfully

Modify Content Filter Rules

Update an existing set of Content Filter Rules for a configuration

put

/api/v4.0/conf/{config}/content-filter-rules

Path parameters

configConfigrequired

Body

categoryCategoryrequired

Category of the rule

idIdrequired

msgMessagerequired

Log message for this rule

nameNamerequired

operandOperandrequired

Matching domain(s) regex

riskRisk Levelrequired

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

subcategorySubcategoryrequired

Subcategory of the rule

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/content-filter-rules' \
  --header 'Content-Type: application/json' \
  --data '[{"category":"text","id":"text","msg":"text","name":"text","operand":"text","risk":1,"subcategory":"text","tags":[],"description":""}]'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Rules updated successfully

Create Content Filter Rules

Create a complete set of Content Filter Rules for a configuration

post

/api/v4.0/conf/{config}/content-filter-rules

Path parameters

configConfigrequired

Body

categoryCategoryrequired

Category of the rule

idIdrequired

msgMessagerequired

Log message for this rule

nameNamerequired

operandOperandrequired

Matching domain(s) regex

riskRisk Levelrequired

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

subcategorySubcategoryrequired

Subcategory of the rule

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/content-filter-rules' \
  --header 'Content-Type: application/json' \
  --data '[{"category":"text","id":"text","msg":"text","name":"text","operand":"text","risk":1,"subcategory":"text","tags":[],"description":""}]'

201

422

{
  "message": "Successfully created entry"
}

Content Filter Rules created successfully

Delete Content Filter Rules

Delete all Content Filter Rules in a configuration

delete

/api/v4.0/conf/{config}/content-filter-rules

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/content-filter-rules'

200

422

{
  "message": "Successfully deleted entry"
}

Content Filter Rules deleted successfully

Get single Content Filter Rule

Get a Content Filter Rule from the specified configuration

get

/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/content-filter-rules/{entry_id}'

200

422

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

Content Filter Rule retrieved successfully

Modify a single Content Filter Rule

Update an individual Content Filter Rule within a configuration

put

/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

categoryCategoryrequired

Category of the rule

idIdrequired

msgMessagerequired

Log message for this rule

nameNamerequired

operandOperandrequired

Matching domain(s) regex

riskRisk Levelrequired

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

subcategorySubcategoryrequired

Subcategory of the rule

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/content-filter-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"category":"text","id":"text","msg":"text","name":"text","operand":"text","risk":1,"subcategory":"text","tags":[],"description":""}'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Rule updated successfully

Create single Content Filter Rule

Create an individual Content Filter Rule within a configuration

post

/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

categoryCategoryrequired

Category of the rule

idIdrequired

msgMessagerequired

Log message for this rule

nameNamerequired

operandOperandrequired

Matching domain(s) regex

riskRisk Levelrequired

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

subcategorySubcategoryrequired

Subcategory of the rule

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/content-filter-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"category":"text","id":"text","msg":"text","name":"text","operand":"text","risk":1,"subcategory":"text","tags":[],"description":""}'

201

422

{
  "message": "Successfully created entry"
}

Content Filter Rule created successfully

Delete single Content Filter Rule

Delete an individual Content Filter Rule from the specified configuration

delete

/api/v4.0/conf/{config}/content-filter-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/content-filter-rules/{entry_id}'

200

422

{
  "message": "Successfully deleted entry"
}

Content Filter Rule deleted successfully

Get Content Filter Rules version list

Get list of versions of Content Filter Rules in a configuration

get

/api/v4.0/conf/{config}/content-filter-rules/versions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/content-filter-rules/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:03:05.689Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Content Filter Rules version list retrieved successfully

Get version of Content Filter Rule set

Get a specific version of a Content Filter Rule set

get

/api/v4.0/conf/{config}/content-filter-rules/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/content-filter-rules/versions/{version}'

200

422

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

Content Filter Rule set retrieved successfully

Revert a Content Filter Rule to the specified version

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

put

/api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/content-filter-rules/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Rule reversion was successful