Content Filter Profiles

PreviousConfigs NextContent Filter Rules

Last updated 5 months ago

Was this helpful?

Get Content Filter Profiles

Get all Content Filter Profiles in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "ignore_alphanum": true,
      "masking_seed": "text",
      "name": "text",
      "active": [],
      "ignore": [],
      "report": [],
      "tags": [],
      "action": "",
      "allsections": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "args": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "cookies": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "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": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "ignore_body": false,
      "path": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "content_type": []
    }
  ]
}

Content Filter Profiles retrieved successfully

Modify Content Filter Profiles

Update an existing set of Content Filter Profiles for a configuration

put

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

Path parameters

configConfigrequired

Body

idIdrequired

ignore_alphanumIgnore Alphanumericrequired

When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored

masking_seedMasking Seedrequired

A seed which will be used in the masking process

nameNamerequired

activeTags List

List of tags to apply

ignoreTags List

List of tags to apply

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

actionAction

allsectionsAll sections

argsArgumentsrequired

cookiesCookiesrequired

decodingActive / Inactive decodingrequired

descriptionDescription

graphql_pathGraphQL Property JSON path

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.

headersHeadersrequired

ignore_bodyIgnore Body

pathPathrequired

content_typeContent Type

List of content types

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/content-filter-profiles' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","ignore_alphanum":true,"masking_seed":"text","name":"text","active":[],"ignore":[],"report":[],"tags":[],"action":"","allsections":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"args":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"cookies":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"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":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"ignore_body":false,"path":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"content_type":[]}]'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Profiles updated successfully

Create Content Filter Profiles

Create a complete set of Content Filter Profiles for a configuration

post

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

Path parameters

configConfigrequired

Body

idIdrequired

ignore_alphanumIgnore Alphanumericrequired

When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored

masking_seedMasking Seedrequired

A seed which will be used in the masking process

nameNamerequired

activeTags List

List of tags to apply

ignoreTags List

List of tags to apply

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

actionAction

allsectionsAll sections

argsArgumentsrequired

cookiesCookiesrequired

decodingActive / Inactive decodingrequired

descriptionDescription

graphql_pathGraphQL Property JSON path

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.

headersHeadersrequired

ignore_bodyIgnore Body

pathPathrequired

content_typeContent Type

List of content types

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/content-filter-profiles' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","ignore_alphanum":true,"masking_seed":"text","name":"text","active":[],"ignore":[],"report":[],"tags":[],"action":"","allsections":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"args":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"cookies":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"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":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"ignore_body":false,"path":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"content_type":[]}]'

201

422

{
  "message": "Successfully created entry"
}

Content Filter Profiles created successfully

Delete Content Filter Profiles

Delete all Content Filter Profiles in a configuration

delete

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Content Filter Profiles deleted successfully

Get single Content Filter Profile

Get a Content Filter Profile from the specified configuration

get

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

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "id": "text",
  "ignore_alphanum": true,
  "masking_seed": "text",
  "name": "text",
  "active": [],
  "ignore": [],
  "report": [],
  "tags": [],
  "action": "",
  "allsections": {
    "enable_max_count": true,
    "enable_max_length": true,
    "max_count": 1,
    "max_length": 1,
    "names": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ],
    "regex": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ]
  },
  "args": {
    "enable_max_count": true,
    "enable_max_length": true,
    "max_count": 1,
    "max_length": 1,
    "names": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ],
    "regex": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ]
  },
  "cookies": {
    "enable_max_count": true,
    "enable_max_length": true,
    "max_count": 1,
    "max_length": 1,
    "names": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ],
    "regex": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ]
  },
  "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": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ],
    "regex": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ]
  },
  "ignore_body": false,
  "path": {
    "enable_max_count": true,
    "enable_max_length": true,
    "max_count": 1,
    "max_length": 1,
    "names": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ],
    "regex": [
      {
        "restrict": true,
        "key": "",
        "mask": false,
        "reg": "",
        "exclusions": []
      }
    ]
  },
  "content_type": []
}

Content Filter Profile retrieved successfully

Modify a single Content Filter Profile

Update an individual Content Filter Profile within a configuration

put

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

Path parameters

configConfigrequired

entry_idEntryrequired

Body

idIdrequired

ignore_alphanumIgnore Alphanumericrequired

When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored

masking_seedMasking Seedrequired

A seed which will be used in the masking process

nameNamerequired

activeTags List

List of tags to apply

ignoreTags List

List of tags to apply

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

actionAction

allsectionsAll sections

argsArgumentsrequired

cookiesCookiesrequired

decodingActive / Inactive decodingrequired

descriptionDescription

graphql_pathGraphQL Property JSON path

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.

headersHeadersrequired

ignore_bodyIgnore Body

pathPathrequired

content_typeContent Type

List of content types

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","ignore_alphanum":true,"masking_seed":"text","name":"text","active":[],"ignore":[],"report":[],"tags":[],"action":"","allsections":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"args":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"cookies":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"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":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"ignore_body":false,"path":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"content_type":[]}'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Profile updated successfully

Create single Content Filter Profile

Create an individual Content Filter Profile within a configuration

post

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

Path parameters

configConfigrequired

entry_idEntryrequired

Body

idIdrequired

ignore_alphanumIgnore Alphanumericrequired

When true, arguments, headers or cookies, which contain only alpha numeric characters, will be ignored

masking_seedMasking Seedrequired

A seed which will be used in the masking process

nameNamerequired

activeTags List

List of tags to apply

ignoreTags List

List of tags to apply

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

actionAction

allsectionsAll sections

argsArgumentsrequired

cookiesCookiesrequired

decodingActive / Inactive decodingrequired

descriptionDescription

graphql_pathGraphQL Property JSON path

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.

headersHeadersrequired

ignore_bodyIgnore Body

pathPathrequired

content_typeContent Type

List of content types

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","ignore_alphanum":true,"masking_seed":"text","name":"text","active":[],"ignore":[],"report":[],"tags":[],"action":"","allsections":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"args":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"cookies":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"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":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"ignore_body":false,"path":{"enable_max_count":true,"enable_max_length":true,"max_count":1,"max_length":1,"names":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}],"regex":[{"restrict":true,"key":"","mask":false,"reg":"","exclusions":[]}]},"content_type":[]}'

201

422

{
  "message": "Successfully created entry"
}

Content Filter Profile created successfully

Delete single Content Filter Profile

Delete an individual Content Filter Profile from the specified configuration

delete

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

Path parameters

configConfigrequired

entry_idEntry IDrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Content Filter Profile deleted successfully

Get Content Filter Profiles version list

Get list of versions of Content Filter Profiles in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Content Filter Profiles version list retrieved successfully

Get version of Content Filter Profile

Get a specific version of a Content Filter Profile

get

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

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "ignore_alphanum": true,
      "masking_seed": "text",
      "name": "text",
      "active": [],
      "ignore": [],
      "report": [],
      "tags": [],
      "action": "",
      "allsections": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "args": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "cookies": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "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": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "ignore_body": false,
      "path": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ],
        "regex": [
          {
            "restrict": true,
            "key": "",
            "mask": false,
            "reg": "",
            "exclusions": []
          }
        ]
      },
      "content_type": []
    }
  ]
}

Content Filter Profile retrieved successfully

Revert a Content Filter Profile to the specified version

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

put

/api/v4.0/conf/{config}/content-filter-profiles/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-profiles/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Profile reversion was successful