v1

latestOpenAPI 3.0.02026-07-17131527.3 KB

policy

Get an existing Agent Policy

get/policies/agent/{id}

Response

Policy object

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

descriptionstring

User description of this Policy

tagsobject

User defined key/values for organization and searching

backendstring

The policy backend to use. Cannot change once created.

ts_createdstring date-time

Timestamp of creation

versioninteger

A monotonically increasing counter starting at 0 on creation and increasing with each policy update.

policyobject

Agent backend specific policy data in json format

formatstring

Policy text format needed to specify when a policy was created in yaml format.

policy_datastring

Agent backend specific policy data in yaml format

Example response

{
  "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"
}