policy

List Agent Policies

get/policies/agent

Query parameters

limitinteger

Size of the subset to retrieve.

offsetinteger

Number of items to skip during retrieval.

namestring

Name filter. Filtering is performed as a case-insensitive partial match.

order'name' | 'id'

Order type.

dir'asc' | 'desc'

Order direction.

tagsobject

Tags filter. Filtering is performed as a case-insensitive partial key value match.

Response

Data retrieved.

totalinteger

Total number of items.

offsetinteger

Number of items to skip during retrieval.

limitinteger

Maximum number of items to return in one page.

Example response

{
  "policy": [
    {
      "name": "my-policy",
      "description": "An example policy",
      "tags": {
        "region": "eu",
        "node_type": "dns"
      },
      "backend": "pktvisor",
      "policy": {
        "handlers": {
          "modules": {
            "default_dns": {
              "type": "dns"
            },
            "default_net": {
              "type": "net"
            }
          }
        },
        "input": {
          "input_type": "pcap",
          "tap": "default_pcap"
        },
        "kind": "collection"
      },
      "format": "yaml",
      "policy_data": "handlers:\n  modules:\n    default_dns:\n      type: dns\n    default_net:\n      type: net\ninput:\n  input_type: pcap\n  tap: default_pcap\nkind: collection"
    }
  ]
}

Changes

Changed in 12 of the 25 revisions of this API.1122

Jul 17, 2026d95ee7691efb1See the full diff
- ▲
  added the new required header request parameter Authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
Oct 4, 2022ce59b3bdec001See the full diff
- ▲
  added the new required header request parameter Bearer authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
Sep 27, 20225085d5b16a492See the full diff
- ▲
  for the query request parameter tags, default value {"key":"value"} was removed
  request-parameter-default-value-removed
- ▲
  for the query request parameter tags, the type/format was changed from string/ to object/
  request-parameter-type-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 28, 20225d3c055b50ec2See the full diff
- ○
  added the optional property policy/items/format to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property policy/items/policy_data to the response with the 200 status
  response-optional-property-added
Sep 22, 2021dc9b53b51fdd1See the full diff
- ▲
  the policy/items/policy response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
Aug 31, 2021adfab293130f11See the full diff
- ▲
  the policy/items/policy response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ○
  added the new optional query request parameter tags
  new-optional-request-parameter
Aug 30, 20210ab4ab3de1eb1See the full diff
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
Aug 27, 20213b5c71fcf13923See the full diff
- ▲
  added the new required header request parameter Authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
Aug 27, 202138562e9cb8e75See the full diff
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 500
  response-media-type-added
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 404
  response-non-success-status-removed
Aug 27, 2021cb4b72ec6b0d29See the full diff
- ▲
  added the new required header request parameter Authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  added the new optional query request parameter dir
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter name
  new-optional-request-parameter
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
- ○
  added the new optional query request parameter order
  new-optional-request-parameter
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (12 revisions)