For the complete documentation index, see llms.txt. This page is also available as Markdown.

Content Filter Profiles

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
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/content-filter-profiles

Modify Content Filter Profiles

put

Update an existing set of Content Filter Profiles for a configuration

Path parameters
configstringRequired
Bodyobject · ContentFilterProfile[]
actionany ofOptionalDefault: ""
stringOptional
activestring[]Optional

List of tags to apply

Default: []
allsectionsany ofOptional
content_typeany ofOptional

List of content types

Default: []
string[]Optional
descriptionstring · nullableOptionalDefault: ""
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
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
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
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/content-filter-profiles

Create Content Filter Profiles

post

Create a complete set of Content Filter Profiles for a configuration

Path parameters
configstringRequired
Bodyobject · ContentFilterProfile[]
actionany ofOptionalDefault: ""
stringOptional
activestring[]Optional

List of tags to apply

Default: []
allsectionsany ofOptional
content_typeany ofOptional

List of content types

Default: []
string[]Optional
descriptionstring · nullableOptionalDefault: ""
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
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
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
messagestringRequired

Information about successful create operation

Example: Successfully created entry
post/api/v4.3/conf/{config}/content-filter-profiles

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
messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry
delete/api/v4.3/conf/{config}/content-filter-profiles

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
actionany ofOptionalDefault: ""
stringOptional
activestring[]Optional

List of tags to apply

Default: []
allsectionsany ofOptional
content_typeany ofOptional

List of content types

Default: []
string[]Optional
descriptionstring · nullableOptionalDefault: ""
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
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
reportstring[]Optional

List of tags to apply

Default: []
tagsstring[]Optional

List of tags to apply

Default: []
get/api/v4.3/conf/{config}/content-filter-profiles/{entry_id}

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
content_typeany ofOptional

List of content types

Default: []
string[]Optional
descriptionstring · nullableOptionalDefault: ""
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
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
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
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/content-filter-profiles/{entry_id}

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
content_typeany ofOptional

List of content types

Default: []
string[]Optional
descriptionstring · nullableOptionalDefault: ""
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
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
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
messagestringRequired

Information about successful create operation

Example: Successfully created entry
post/api/v4.3/conf/{config}/content-filter-profiles/{entry_id}

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
messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry
delete/api/v4.3/conf/{config}/content-filter-profiles/{entry_id}

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
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/content-filter-profiles/versions

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
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/content-filter-profiles/versions/{version}

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
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/content-filter-profiles/versions/{version}/revert

Last updated

Was this helpful?