Content Filter Rules

PreviousContent Filter Profiles NextData queries

Last updated 7 months ago

Was this helpful?

Delete Content Filter Rules

delete

Delete all Content Filter Rules in a configuration

Path parameters

configstringRequired

Responses

application/json

objectOptional

application/json

delete

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

application/json

objectOptional

application/json

get

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

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

Delete single Content Filter Rule

delete

Delete an individual Content Filter Rule from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

application/json

objectOptional

application/json

delete

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

application/json

objectOptional

application/json

get

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

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-04-24T07:16:23.621Z",
      "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

application/json

objectOptional

application/json

get

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

{
  "total": 1,
  "items": [
    {
      "category": "text",
      "description": "text",
      "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

application/json

objectOptional

application/json

put

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

{
  "message": "Successfully updated entry"
}

Get Content Filter Rules

get

Get all Content Filter Rules in a configuration

Path parameters

configstringRequired

Responses

application/json

objectOptional

application/json

get

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

{
  "total": 1,
  "items": [
    {
      "category": "text",
      "description": "text",
      "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

Body

categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""

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

application/json

objectOptional

application/json

put

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

[
  {
    "category": "text",
    "description": "text",
    "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

Body

categorystringRequired

Category of the rule

descriptionany ofOptionalDefault: ""

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

application/json

objectOptional

application/json

post

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

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

{
  "message": "Successfully created entry"
}

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: ""

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

application/json

objectOptional

application/json

put

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

{
  "category": "text",
  "description": "text",
  "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: ""

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

application/json

objectOptional

application/json

post

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

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

{
  "message": "Successfully created entry"
}