Security Policies

PreviousSecurity Alerts NextServer Groups

Last updated 1 month ago

Was this helpful?

Get Security Policies

Get all Security Policies in a configuration

get

/api/v4.0/conf/{config}/security-policies

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/security-policies'

200

422

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "map": [
        {
          "acl_profile_active": true,
          "acl_profile": "text",
          "backend_service": "text",
          "content_filter_profile_active": true,
          "content_filter_profile": "text",
          "description": "text",
          "id": "text",
          "match": "text",
          "name": "text",
          "edge_functions": [
            "text"
          ],
          "rate_limit_rules": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "session": 1,
      "session_ids": 1
    }
  ]
}

Security Policies retrieved successfully

Modify Security Policies

Update an existing set of Security Policies for a configuration

put

/api/v4.0/conf/{config}/security-policies

Path parameters

configConfigrequired

Body

descriptionDescription

idIdrequired

nameNamerequired

mapMap

tagsTags

sessionSession

session_idsSession Ids

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-policies' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","name":"text","map":[{"acl_profile_active":true,"acl_profile":"text","backend_service":"text","content_filter_profile_active":true,"content_filter_profile":"text","description":"text","id":"text","match":"text","name":"text","edge_functions":["text"],"rate_limit_rules":["text"]}],"tags":[null]}]'

200

422

{
  "message": "Successfully updated entry"
}

Security Policies updated successfully

Create Security Policies

Create a complete set of Security Policies for a configuration

post

/api/v4.0/conf/{config}/security-policies

Path parameters

configConfigrequired

Body

descriptionDescription

idIdrequired

nameNamerequired

mapMap

tagsTags

sessionSession

session_idsSession Ids

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/security-policies' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","name":"text","map":[{"acl_profile_active":true,"acl_profile":"text","backend_service":"text","content_filter_profile_active":true,"content_filter_profile":"text","description":"text","id":"text","match":"text","name":"text","edge_functions":["text"],"rate_limit_rules":["text"]}],"tags":[null]}]'

201

422

{
  "message": "Successfully created entry"
}

Security Policies created successfully

Delete Security Policies

Delete all Security Policies in a configuration

delete

/api/v4.0/conf/{config}/security-policies

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/security-policies'

200

422

{
  "message": "Successfully deleted entry"
}

Security Policies deleted successfully

Get specific Security Policy

Get a Security Policy from the specified configuration

get

/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/security-policies/{entry_id}'

200

422

{
  "description": "text",
  "id": "text",
  "name": "text",
  "map": [
    {
      "acl_profile_active": true,
      "acl_profile": "text",
      "backend_service": "text",
      "content_filter_profile_active": true,
      "content_filter_profile": "text",
      "description": "text",
      "id": "text",
      "match": "text",
      "name": "text",
      "edge_functions": [
        "text"
      ],
      "rate_limit_rules": [
        "text"
      ]
    }
  ],
  "tags": [
    "text"
  ],
  "session": 1,
  "session_ids": 1
}

Security Policy retrieved successfully

Modify a single Security Policy

Update an individual Security Policy within a configuration

put

/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

descriptionDescription

idIdrequired

nameNamerequired

mapMap

tagsTags

sessionSession

session_idsSession Ids

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-policies/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","name":"text","map":[{"acl_profile_active":true,"acl_profile":"text","backend_service":"text","content_filter_profile_active":true,"content_filter_profile":"text","description":"text","id":"text","match":"text","name":"text","edge_functions":["text"],"rate_limit_rules":["text"]}],"tags":[null]}'

200

422

{
  "message": "Successfully updated entry"
}

Security Policy updated successfully

Create single Security Policy

Create an individual Security Policy within a configuration

post

/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

descriptionDescription

idIdrequired

nameNamerequired

mapMap

tagsTags

sessionSession

session_idsSession Ids

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/security-policies/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","name":"text","map":[{"acl_profile_active":true,"acl_profile":"text","backend_service":"text","content_filter_profile_active":true,"content_filter_profile":"text","description":"text","id":"text","match":"text","name":"text","edge_functions":["text"],"rate_limit_rules":["text"]}],"tags":[null]}'

201

422

{
  "message": "Successfully created entry"
}

Security Policy created successfully

Delete single Security Policy

Delete an individual Security Policy from the specified configuration

delete

/api/v4.0/conf/{config}/security-policies/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/security-policies/{entry_id}'

200

422

{
  "message": "Successfully deleted entry"
}

Security Policy deleted successfully

Get Security Policies version list

Get list of versions of Security Policies in a configuration

get

/api/v4.0/conf/{config}/security-policies/versions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/security-policies/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:09:01.472Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Security Policies version list retrieved successfully

Get version of Security Policy

Get a specific version of a Security Policy

get

/api/v4.0/conf/{config}/security-policies/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/security-policies/versions/{version}'

200

422

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "map": [
        {
          "acl_profile_active": true,
          "acl_profile": "text",
          "backend_service": "text",
          "content_filter_profile_active": true,
          "content_filter_profile": "text",
          "description": "text",
          "id": "text",
          "match": "text",
          "name": "text",
          "edge_functions": [
            "text"
          ],
          "rate_limit_rules": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "session": 1,
      "session_ids": 1
    }
  ]
}

Security Policy retrieved successfully

Revert a Security Policy to the specified version

Set a previous Security Policy version to be the current one

put

/api/v4.0/conf/{config}/security-policies/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-policies/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Security Policy reversion was successful