Content Filter Profiles

PreviousConfigs NextContent Filter Rules

Last updated 9 days ago

Was this helpful?

Delete single Content Filter Profile

delete

Delete an individual Content Filter Profile from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

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 version of Content Filter Profile

get

Get a specific version of a Content Filter Profile

Path parameters

configstringrequired

versionstringrequired

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

Content Filter Profile retrieved successfully

Modify a single Content Filter Profile

put

Update an individual Content Filter Profile within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionany of · default: ""optional

activestring[] · default: []optional

List of tags to apply

allsectionsany ofoptional

argsall ofrequired

content_typeany of · default: []optional

List of content types

cookiesall ofrequired

decodingall ofrequired

descriptionany of · default: ""optional

graphql_pathany of · default: ""optional

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.

headersall ofrequired

idstringrequired

ignorestring[] · default: []optional

List of tags to apply

ignore_alphanumbooleanrequired

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

ignore_bodyany of · default: falseoptional

masking_seedstringrequired

A seed which will be used in the masking process

namestring · min: 1required

pathall ofrequired

reportstring[] · default: []optional

List of tags to apply

tagsstring[] · default: []optional

List of tags to apply

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

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Profile updated successfully

Create single Content Filter Profile

post

Create an individual Content Filter Profile within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionany of · default: ""optional

activestring[] · default: []optional

List of tags to apply

allsectionsany ofoptional

argsall ofrequired

content_typeany of · default: []optional

List of content types

cookiesall ofrequired

decodingall ofrequired

descriptionany of · default: ""optional

graphql_pathany of · default: ""optional

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.

headersall ofrequired

idstringrequired

ignorestring[] · default: []optional

List of tags to apply

ignore_alphanumbooleanrequired

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

ignore_bodyany of · default: falseoptional

masking_seedstringrequired

A seed which will be used in the masking process

namestring · min: 1required

pathall ofrequired

reportstring[] · default: []optional

List of tags to apply

tagsstring[] · default: []optional

List of tags to apply

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

201

422

{
  "message": "Successfully created entry"
}

Content Filter Profile created successfully

Modify Content Filter Profiles

put

Update an existing set of Content Filter Profiles for a configuration

Path parameters

configstringrequired

Body

actionany of · default: ""optional

activestring[] · default: []optional

List of tags to apply

allsectionsany ofoptional

argsall ofrequired

content_typeany of · default: []optional

List of content types

cookiesall ofrequired

decodingall ofrequired

descriptionany of · default: ""optional

graphql_pathany of · default: ""optional

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.

headersall ofrequired

idstringrequired

ignorestring[] · default: []optional

List of tags to apply

ignore_alphanumbooleanrequired

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

ignore_bodyany of · default: falseoptional

masking_seedstringrequired

A seed which will be used in the masking process

namestring · min: 1required

pathall ofrequired

reportstring[] · default: []optional

List of tags to apply

tagsstring[] · default: []optional

List of tags to apply

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

200

422

{
  "message": "Successfully updated entry"
}

Content Filter Profiles updated successfully

Get Content Filter Profiles

get

Get all Content Filter Profiles in a configuration

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Content Filter Profiles retrieved successfully

Delete Content Filter Profiles

delete

Delete all Content Filter Profiles in a configuration

Path parameters

configstringrequired

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

Get a Content Filter Profile from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Content Filter Profile retrieved successfully

Get Content Filter Profiles version list

get

Get list of versions of Content Filter Profiles in a configuration

Path parameters

configstringrequired

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": "name@gmail.com",
      "message": "text",
      "date": "2025-04-03T05:37:26.145Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Content Filter Profiles version list retrieved successfully

Revert a Content Filter Profile to the specified version

put

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

Path parameters

configstringrequired

versionstringrequired

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

Create Content Filter Profiles

post

Create a complete set of Content Filter Profiles for a configuration

Path parameters

configstringrequired

Body

actionany of · default: ""optional

activestring[] · default: []optional

List of tags to apply

allsectionsany ofoptional

argsall ofrequired

content_typeany of · default: []optional

List of content types

cookiesall ofrequired

decodingall ofrequired

descriptionany of · default: ""optional

graphql_pathany of · default: ""optional

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.

headersall ofrequired

idstringrequired

ignorestring[] · default: []optional

List of tags to apply

ignore_alphanumbooleanrequired

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

ignore_bodyany of · default: falseoptional

masking_seedstringrequired

A seed which will be used in the masking process

namestring · min: 1required

pathall ofrequired

reportstring[] · default: []optional

List of tags to apply

tagsstring[] · default: []optional

List of tags to apply

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 '[
    {
      "action": "text",
      "active": [
        "text"
      ],
      "allsections": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ],
        "regex": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ]
      },
      "args": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ],
        "regex": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ]
      },
      "content_type": [
        "text"
      ],
      "cookies": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ],
        "regex": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ]
      },
      "decoding": {
        "base64": true,
        "dual": true,
        "html": true,
        "unicode": true
      },
      "description": "text",
      "graphql_path": "text",
      "headers": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ],
        "regex": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ]
      },
      "id": "text",
      "ignore": [
        "text"
      ],
      "ignore_alphanum": true,
      "ignore_body": true,
      "masking_seed": "text",
      "name": "text",
      "path": {
        "enable_max_count": true,
        "enable_max_length": true,
        "max_count": 1,
        "max_length": 1,
        "names": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ],
        "regex": [
          {
            "ignore_cf_rule_tags": [
              "text"
            ],
            "key": "text",
            "mask": true,
            "reg": "text",
            "restrict": true
          }
        ]
      },
      "report": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]'

201

422

{
  "message": "Successfully created entry"
}

Content Filter Profiles created successfully

Delete single Content Filter Profile

Get version of Content Filter Profile

Modify a single Content Filter Profile

Show child attributes

Show ContentFilterProfileSection

Show ContentFilterProfileSection

Show string

Show ContentFilterProfileSection

Show Decoding

Show child attributes

Show child attributes

Show child attributes

Show ContentFilterProfileSection

Show child attributes

Show ContentFilterProfileSection

Create single Content Filter Profile

Show child attributes

Show ContentFilterProfileSection

Show ContentFilterProfileSection

Show string

Show ContentFilterProfileSection

Show Decoding

Show child attributes

Show child attributes

Show child attributes

Show ContentFilterProfileSection

Show child attributes

Show ContentFilterProfileSection

Modify Content Filter Profiles

Show child attributes

Show ContentFilterProfileSection

Show ContentFilterProfileSection

Show string

Show ContentFilterProfileSection

Show Decoding

Show child attributes

Show child attributes

Show child attributes

Show ContentFilterProfileSection

Show child attributes

Show ContentFilterProfileSection

Get Content Filter Profiles

Delete Content Filter Profiles

Get single Content Filter Profile

Get Content Filter Profiles version list

Revert a Content Filter Profile to the specified version

Create Content Filter Profiles

Show child attributes

Show ContentFilterProfileSection

Show ContentFilterProfileSection

Show string

Show ContentFilterProfileSection

Show Decoding

Show child attributes

Show child attributes

Show child attributes

Show ContentFilterProfileSection

Show child attributes

Show ContentFilterProfileSection