Content Filter Profiles

PreviousConfigs NextContent Filter Rules

Last updated 1 month 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

200

Content Filter Profile deleted successfully

application/json

422

Validation Error

application/json

delete

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

{
  "message": "Successfully deleted entry"
}

Get version of Content Filter Profile

get

Get a specific version of a Content Filter Profile

Path parameters

configstringRequired

versionstringRequired

Responses

200

Content Filter Profile retrieved successfully

application/json

422

Validation Error

application/json

get

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

{
  "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"
      ]
    }
  ]
}

Modify a single Content Filter Profile

put

Update an individual Content Filter Profile within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

actionany ofOptionalDefault: ""

stringOptional

activestring[]Optional

List of tags to apply

Default: []

allsectionsany ofOptional

argsall ofRequired

content_typeany ofOptional

List of content types

Default: []

string[]Optional

cookiesall ofRequired

decodingall ofRequired

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

graphql_pathany ofOptional

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.

Default: ""

stringOptional

headersall ofRequired

idstringRequired

ignorestring[]Optional

List of tags to apply

Default: []

ignore_alphanumbooleanRequired

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

ignore_bodyany ofOptionalDefault: false

booleanOptional

masking_seedstringRequired

A seed which will be used in the masking process

namestring · min: 1Required

pathall ofRequired

reportstring[]Optional

List of tags to apply

Default: []

tagsstring[]Optional

List of tags to apply

Default: []

Responses

200

Content Filter Profile updated successfully

application/json

422

Validation Error

application/json

put

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

{
  "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"
  ]
}

{
  "message": "Successfully updated entry"
}

Create single Content Filter Profile

post

Create an individual Content Filter Profile within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

actionany ofOptionalDefault: ""

stringOptional

activestring[]Optional

List of tags to apply

Default: []

allsectionsany ofOptional

argsall ofRequired

content_typeany ofOptional

List of content types

Default: []

string[]Optional

cookiesall ofRequired

decodingall ofRequired

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

graphql_pathany ofOptional

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.

Default: ""

stringOptional

headersall ofRequired

idstringRequired

ignorestring[]Optional

List of tags to apply

Default: []

ignore_alphanumbooleanRequired

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

ignore_bodyany ofOptionalDefault: false

booleanOptional

masking_seedstringRequired

A seed which will be used in the masking process

namestring · min: 1Required

pathall ofRequired

reportstring[]Optional

List of tags to apply

Default: []

tagsstring[]Optional

List of tags to apply

Default: []

Responses

201

Content Filter Profile created successfully

application/json

422

Validation Error

application/json

post

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

{
  "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"
  ]
}

{
  "message": "Successfully created entry"
}

Modify Content Filter Profiles

put

Update an existing set of Content Filter Profiles for a configuration

Path parameters

configstringRequired

Body

actionany ofOptionalDefault: ""

stringOptional

activestring[]Optional

List of tags to apply

Default: []

allsectionsany ofOptional

argsall ofRequired

content_typeany ofOptional

List of content types

Default: []

string[]Optional

cookiesall ofRequired

decodingall ofRequired

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

graphql_pathany ofOptional

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.

Default: ""

stringOptional

headersall ofRequired

idstringRequired

ignorestring[]Optional

List of tags to apply

Default: []

ignore_alphanumbooleanRequired

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

ignore_bodyany ofOptionalDefault: false

booleanOptional

masking_seedstringRequired

A seed which will be used in the masking process

namestring · min: 1Required

pathall ofRequired

reportstring[]Optional

List of tags to apply

Default: []

tagsstring[]Optional

List of tags to apply

Default: []

Responses

200

Content Filter Profiles updated successfully

application/json

422

Validation Error

application/json

put

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

[
  {
    "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"
    ]
  }
]

{
  "message": "Successfully updated entry"
}

Get Content Filter Profiles

get

Get all Content Filter Profiles in a configuration

Path parameters

configstringRequired

Responses

200

Content Filter Profiles retrieved successfully

application/json

422

Validation Error

application/json

get

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

{
  "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"
      ]
    }
  ]
}

Delete Content Filter Profiles

delete

Delete all Content Filter Profiles in a configuration

Path parameters

configstringRequired

Responses

200

Content Filter Profiles deleted successfully

application/json

422

Validation Error

application/json

delete

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

{
  "message": "Successfully deleted entry"
}

Get single Content Filter Profile

get

Get a Content Filter Profile from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Content Filter Profile retrieved successfully

application/json

422

Validation Error

application/json

get

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

{
  "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"
  ]
}

Get Content Filter Profiles version list

get

Get list of versions of Content Filter Profiles in a configuration

Path parameters

configstringRequired

Responses

200

Content Filter Profiles version list retrieved successfully

application/json

422

Validation Error

application/json

get

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

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-05-03T17:12:48.058Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

200

Content Filter Profile reversion was successful

application/json

422

Validation Error

application/json

put

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

{
  "message": "Successfully updated entry"
}

Create Content Filter Profiles

post

Create a complete set of Content Filter Profiles for a configuration

Path parameters

configstringRequired

Body

actionany ofOptionalDefault: ""

stringOptional

activestring[]Optional

List of tags to apply

Default: []

allsectionsany ofOptional

argsall ofRequired

content_typeany ofOptional

List of content types

Default: []

string[]Optional

cookiesall ofRequired

decodingall ofRequired

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

graphql_pathany ofOptional

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.

Default: ""

stringOptional

headersall ofRequired

idstringRequired

ignorestring[]Optional

List of tags to apply

Default: []

ignore_alphanumbooleanRequired

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

ignore_bodyany ofOptionalDefault: false

booleanOptional

masking_seedstringRequired

A seed which will be used in the masking process

namestring · min: 1Required

pathall ofRequired

reportstring[]Optional

List of tags to apply

Default: []

tagsstring[]Optional

List of tags to apply

Default: []

Responses

201

Content Filter Profiles created successfully

application/json

422

Validation Error

application/json

post

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

[
  {
    "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"
    ]
  }
]

{
  "message": "Successfully created entry"
}