Security Policies

Get Security Policies

Get all Security Policies in a configuration

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

Path parameters

config*Config

Response

200422

Security Policies retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of SecurityPolicy

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "map": [
        {
          "acl_active": false,
          "acl_profile": "text",
          "backend_id": "text",
          "cloud_functions": [
            "text"
          ],
          "content_filter_active": false,
          "content_filter_profile": "text",
          "description": "text",
          "id": "text",
          "limit_ids": [
            "text"
          ],
          "match": "text",
          "name": "text"
        }
      ],
      "match": "text",
      "name": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Modify Security Policies

Update an existing set of Security Policies for a configuration

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

Path parameters

config*Config

Body

application/json

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

integernumberbooleananyarray of any

session_idsSession Ids

integernumberbooleananyarray of any

tagsTags

Response

200422

Security Policies updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "match": "text"
      }
    ]),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create Security Policies

Create a complete set of Security Policies for a configuration

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

Path parameters

config*Config

Body

application/json

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

integernumberbooleananyarray of any

session_idsSession Ids

integernumberbooleananyarray of any

tagsTags

Response

201422

Security Policies created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "match": "text"
      }
    ]),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete Security Policies

Delete all Security Policies in a configuration

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

Path parameters

config*Config

Response

200422

Security Policies deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

Get specific Security Policy

Get a Security Policy from the specified configuration

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

Path parameters

config*Config

entry_id*Entry

Response

200422

Security Policy retrieved successfully

Body

application/json

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

integernumberbooleananyarray of any

session_idsSession Ids

integernumberbooleananyarray of any

tagsTags

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "description": "text",
  "id": "text",
  "map": [
    {
      "acl_active": false,
      "acl_profile": "text",
      "backend_id": "text",
      "cloud_functions": [
        "text"
      ],
      "content_filter_active": false,
      "content_filter_profile": "text",
      "description": "text",
      "id": "text",
      "limit_ids": [
        "text"
      ],
      "match": "text",
      "name": "text"
    }
  ],
  "match": "text",
  "name": "text",
  "tags": [
    "text"
  ]
}

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

config*Config

entry_id*Entry

Body

application/json

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

integernumberbooleananyarray of any

session_idsSession Ids

integernumberbooleananyarray of any

tagsTags

Response

200422

Security Policy updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "match": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create single Security Policy

Create an individual Security Policy within a configuration

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

Path parameters

config*Config

entry_id*Entry

Body

application/json

descriptionDescription

id*Id

mapMap

match*Match

name*Name

sessionSession

integernumberbooleananyarray of any

session_idsSession Ids

integernumberbooleananyarray of any

tagsTags

Response

201422

Security Policy created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "match": "text"
    }),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry

Response

200422

Security Policy deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

200422

Security Policies version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-11-21T06:40:40.161Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Security Policy retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of SecurityPolicy

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "map": [
        {
          "acl_active": false,
          "acl_profile": "text",
          "backend_id": "text",
          "cloud_functions": [
            "text"
          ],
          "content_filter_active": false,
          "content_filter_profile": "text",
          "description": "text",
          "id": "text",
          "limit_ids": [
            "text"
          ],
          "match": "text",
          "name": "text"
        }
      ],
      "match": "text",
      "name": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Security Policy reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-policies/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}