Content Filter Profiles

Get Content Filter Profiles

Get all Content Filter Profiles in a configuration

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

Path parameters

config*Config

Response

200422

Content Filter Profiles retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of ContentFilterProfile

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "active": [
        "text"
      ],
      "allsections": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "args": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "content_type": [
        "text"
      ],
      "cookies": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "decoding": {
        "base64": false,
        "dual": false,
        "html": false,
        "unicode": false
      },
      "description": "text",
      "graphql_path": "text",
      "headers": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "id": "text",
      "ignore": [
        "text"
      ],
      "ignore_alphanum": false,
      "ignore_body": false,
      "masking_seed": "text",
      "name": "text",
      "path": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "report": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

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

config*Config

Body

application/json

actionAction

string

activeTags List

List of tags to apply

allsectionsAll sections

ContentFilterProfileSection

args*Arguments

content_typeContent Type

List of content types

array of string

cookies*Cookies

decoding*Active / Inactive decoding

descriptionDescription

stringnull

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.

string

headers*Headers

id*Id

ignoreTags List

List of tags to apply

ignore_alphanum*Ignore Alphanumeric

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

ignore_bodyIgnore Body

boolean

masking_seed*Masking Seed

A seed which will be used in the masking process

name*Name

path*Path

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

Response

200422

Content Filter Profiles updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "ignore_alphanum": false,
        "args": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "headers": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "cookies": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "path": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "decoding": {},
        "masking_seed": "text"
      }
    ]),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

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

config*Config

Body

application/json

actionAction

string

activeTags List

List of tags to apply

allsectionsAll sections

ContentFilterProfileSection

args*Arguments

content_typeContent Type

List of content types

array of string

cookies*Cookies

decoding*Active / Inactive decoding

descriptionDescription

stringnull

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.

string

headers*Headers

id*Id

ignoreTags List

List of tags to apply

ignore_alphanum*Ignore Alphanumeric

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

ignore_bodyIgnore Body

boolean

masking_seed*Masking Seed

A seed which will be used in the masking process

name*Name

path*Path

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

Response

201422

Content Filter Profiles created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "ignore_alphanum": false,
        "args": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "headers": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "cookies": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "path": {
          "names": [
            {
              "restrict": false
            }
          ],
          "regex": [
            {
              "restrict": false
            }
          ],
          "enable_max_length": false,
          "enable_max_count": false
        },
        "decoding": {},
        "masking_seed": "text"
      }
    ]),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete Content Filter Profiles

Delete all Content Filter Profiles in a configuration

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

Path parameters

config*Config

Response

200422

Content Filter Profiles deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

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

config*Config

entry_id*Entry

Response

200422

Content Filter Profile retrieved successfully

Body

application/json

actionAction

string

activeTags List

List of tags to apply

allsectionsAll sections

ContentFilterProfileSection

args*Arguments

content_typeContent Type

List of content types

array of string

cookies*Cookies

decoding*Active / Inactive decoding

descriptionDescription

stringnull

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.

string

headers*Headers

id*Id

ignoreTags List

List of tags to apply

ignore_alphanum*Ignore Alphanumeric

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

ignore_bodyIgnore Body

boolean

masking_seed*Masking Seed

A seed which will be used in the masking process

name*Name

path*Path

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "action": "text",
  "active": [
    "text"
  ],
  "allsections": {
    "enable_max_count": false,
    "enable_max_length": false,
    "names": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ],
    "regex": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ]
  },
  "args": {
    "enable_max_count": false,
    "enable_max_length": false,
    "names": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ],
    "regex": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ]
  },
  "content_type": [
    "text"
  ],
  "cookies": {
    "enable_max_count": false,
    "enable_max_length": false,
    "names": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ],
    "regex": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ]
  },
  "decoding": {
    "base64": false,
    "dual": false,
    "html": false,
    "unicode": false
  },
  "description": "text",
  "graphql_path": "text",
  "headers": {
    "enable_max_count": false,
    "enable_max_length": false,
    "names": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ],
    "regex": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ]
  },
  "id": "text",
  "ignore": [
    "text"
  ],
  "ignore_alphanum": false,
  "ignore_body": false,
  "masking_seed": "text",
  "name": "text",
  "path": {
    "enable_max_count": false,
    "enable_max_length": false,
    "names": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ],
    "regex": [
      {
        "exclusions": [
          "text"
        ],
        "key": "text",
        "mask": false,
        "reg": "text",
        "restrict": false
      }
    ]
  },
  "report": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

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

config*Config

entry_id*Entry

Body

application/json

actionAction

string

activeTags List

List of tags to apply

allsectionsAll sections

ContentFilterProfileSection

args*Arguments

content_typeContent Type

List of content types

array of string

cookies*Cookies

decoding*Active / Inactive decoding

descriptionDescription

stringnull

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.

string

headers*Headers

id*Id

ignoreTags List

List of tags to apply

ignore_alphanum*Ignore Alphanumeric

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

ignore_bodyIgnore Body

boolean

masking_seed*Masking Seed

A seed which will be used in the masking process

name*Name

path*Path

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

Response

200422

Content Filter Profile updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "ignore_alphanum": false,
      "args": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "headers": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "cookies": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "path": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "decoding": {},
      "masking_seed": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

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

config*Config

entry_id*Entry

Body

application/json

actionAction

string

activeTags List

List of tags to apply

allsectionsAll sections

ContentFilterProfileSection

args*Arguments

content_typeContent Type

List of content types

array of string

cookies*Cookies

decoding*Active / Inactive decoding

descriptionDescription

stringnull

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.

string

headers*Headers

id*Id

ignoreTags List

List of tags to apply

ignore_alphanum*Ignore Alphanumeric

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

ignore_bodyIgnore Body

boolean

masking_seed*Masking Seed

A seed which will be used in the masking process

name*Name

path*Path

reportTags List

List of tags to apply

tagsTags List

List of tags to apply

Response

201422

Content Filter Profile created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "ignore_alphanum": false,
      "args": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "headers": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "cookies": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "path": {
        "names": [
          {
            "restrict": false
          }
        ],
        "regex": [
          {
            "restrict": false
          }
        ],
        "enable_max_length": false,
        "enable_max_count": false
      },
      "decoding": {},
      "masking_seed": "text"
    }),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry ID

Response

200422

Content Filter Profile deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

200422

Content Filter Profiles version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-09-19T16:02:48.157Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Content Filter Profile retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of ContentFilterProfile

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "active": [
        "text"
      ],
      "allsections": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "args": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "content_type": [
        "text"
      ],
      "cookies": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "decoding": {
        "base64": false,
        "dual": false,
        "html": false,
        "unicode": false
      },
      "description": "text",
      "graphql_path": "text",
      "headers": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "id": "text",
      "ignore": [
        "text"
      ],
      "ignore_alphanum": false,
      "ignore_body": false,
      "masking_seed": "text",
      "name": "text",
      "path": {
        "enable_max_count": false,
        "enable_max_length": false,
        "names": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ],
        "regex": [
          {
            "exclusions": [
              "text"
            ],
            "key": "text",
            "mask": false,
            "reg": "text",
            "restrict": false
          }
        ]
      },
      "report": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Content Filter Profile reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/content-filter-profiles/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}