Security Policies
Get all Security Policies in a configuration
Path parameters
configstringRequired
Responses
200
Security Policies retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
}
Update an existing set of Security Policies for a configuration
Path parameters
configstringRequired
Bodyobject · SecurityPolicy[]
descriptionstringOptional
idstringRequired
namestringRequired
sessionany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
session_idsany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
tagsstring[]Optional
Responses
200
Security Policies updated successfully
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 361
[
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
{
"message": "Successfully updated entry"
}
Create a complete set of Security Policies for a configuration
Path parameters
configstringRequired
Bodyobject · SecurityPolicy[]
descriptionstringOptional
idstringRequired
namestringRequired
sessionany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
session_idsany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
tagsstring[]Optional
Responses
201
Security Policies created successfully
application/json
422
Validation Error
application/json
post
POST /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 361
[
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
{
"message": "Successfully created entry"
}
Delete all Security Policies in a configuration
Path parameters
configstringRequired
Responses
200
Security Policies deleted successfully
application/json
422
Validation Error
application/json
delete
DELETE /api/v4.0/conf/{config}/security-policies HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get a Security Policy from the specified configuration
Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Security Policy retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
Update an individual Security Policy within a configuration
Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestringRequired
sessionany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
session_idsany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
tagsstring[]Optional
Responses
200
Security Policy updated successfully
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
{
"message": "Successfully updated entry"
}
Create an individual Security Policy within a configuration
Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestringRequired
sessionany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
session_idsany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
tagsstring[]Optional
Responses
201
Security Policy created successfully
application/json
422
Validation Error
application/json
post
POST /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
{
"message": "Successfully created entry"
}
Delete an individual Security Policy from the specified configuration
Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Security Policy deleted successfully
application/json
422
Validation Error
application/json
delete
DELETE /api/v4.0/conf/{config}/security-policies/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of Security Policies in a configuration
Path parameters
configstringRequired
Responses
200
Security Policies version list retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/security-policies/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-07-12T09:33:37.447Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of a Security Policy
Path parameters
configstringRequired
versionstringRequired
Responses
200
Security Policy retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/security-policies/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"description": "text",
"id": "text",
"map": [
{
"acl_profile_active": true,
"acl_profile": "text",
"backend_service": "text",
"edge_functions": [
"text"
],
"content_filter_profile_active": true,
"content_filter_profile": "text",
"description": "text",
"id": "text",
"rate_limit_rules": [
"text"
],
"match": "text",
"name": "text"
}
],
"name": "text",
"session": 1,
"session_ids": 1,
"tags": [
"text"
]
}
]
}
Set a previous Security Policy version to be the current one
Path parameters
configstringRequired
versionstringRequired
Responses
200
Security Policy reversion was successful
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/security-policies/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?