Download OpenAPI specification:Download
limit | integer [ 1 .. 100 ] Default: 10 Size of the subset to retrieve. |
offset | integer >= 0 Default: 0 Number of items to skip during retrieval. |
name | string Name filter. Filtering is performed as a case-insensitive partial match. |
order | string Default: "id" Enum: "name" "id" Order type. |
dir | string Default: "desc" Enum: "asc" "desc" Order direction. |
tags | string Default: "{\"key\":\"value\"}" Tags filter. Filtering is performed as a case-insensitive partial key value match. |
Authorization required | string <jwt> User's access token. |
{- "policy": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "my-policy",
- "description": "An example policy",
- "tags": {
- "region": "eu",
- "node_type": "dns"
}, - "backend": "pktvisor",
- "ts_created": "2019-08-24T14:15:22Z",
- "version": 0,
- "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"
}
], - "total": 0,
- "offset": 0,
- "limit": 0
}
Authorization required | string <jwt> User's access token. |
JSON-formatted document describing the new Policy configuration
name required | string A unique name label |
description | string User description of this Policy |
tags required | object User defined key/values for organization and searching |
version | integer Currente version of agent policy |
backend required | string Agent backend this policy is for. Cannot change once created. |
schema_version | string Schema version which needs to match the schema defined by the backend which will use the policy. |
required | object Agent backend specific policy data in json format |
{- "name": "my-policy",
- "description": "A policy example",
- "tags": {
- "region": "eu",
- "node_type": "dns"
}, - "version": 1,
- "backend": "pktvisor",
- "schema_version": "1.0",
- "policy": {
- "handlers": {
- "modules": {
- "default_dns": {
- "type": "dns"
}, - "default_net": {
- "type": "net"
}
}
}, - "input": {
- "input_type": "pcap",
- "tap": "default_pcap"
}, - "kind": "collection"
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "my-policy",
- "description": "An example policy",
- "tags": {
- "region": "eu",
- "node_type": "dns"
}, - "backend": "pktvisor",
- "ts_created": "2019-08-24T14:15:22Z",
- "version": 0,
- "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"
}
id required | string <uuid> Unique Agent Policy identifier. |
Authorization required | string <jwt> User's access token. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "my-policy",
- "description": "An example policy",
- "tags": {
- "region": "eu",
- "node_type": "dns"
}, - "backend": "pktvisor",
- "ts_created": "2019-08-24T14:15:22Z",
- "version": 0,
- "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"
}
id required | string <uuid> Unique Agent Policy identifier. |
Authorization required | string <jwt> User's access token. |
JSON-formatted document describing the updated Policy configuration
name | string A unique name label |
description | string User description of this Policy |
tags | object User defined key/values for organization and searching |
object Agent backend specific policy data in json format |
{- "name": "my-policy",
- "description": "A policy example",
- "tags": {
- "region": "eu",
- "node_type": "dns"
}, - "policy": {