HomeGuidesAPI Reference
API Reference

Create or update compound application definition

Creates or updates a user-defined compound application definition for multi-attribute traffic classification. Compound rules combine two or more attributes (IP, port, DNS, geo, service, DSCP, VLAN, protocol) to identify applications. Simple single-attribute rules are rejected - use dedicated endpoints: /portProtocolClassification for TCP/UDP, /ipIntelligenceClassification for Address Map, or /dnsClassification for Domain Name rules. Upon success, merged data and hashcode are automatically updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
≥ 1

Unique identifier of the compound application definition. Must be > 0 and match the id in the request body. IDs > 50000 are portal-modified user records requiring existing portal data.

Body Params

Compound application definition object containing rule attributes. At least two attributes must be specified (non-empty) to qualify as a compound rule.

Compound application definition for multi-attribute traffic classification. Combines multiple matching criteria to identify network applications.

integer
required
≥ 1

Unique identifier for the compound rule. IDs > 50000 are user-modified portal records. Must match query parameter.

string
required
length ≤ 31
^[a-zA-Z0-9_-]{1,31}$

Application name. Required, alphanumeric/hyphen/underscore only, max 31 characters.

integer
required
1 to 100

Classification confidence level. Higher values increase match priority.

string
required

Optional description of the rule. Cannot contain pipe character '|'.

boolean
required
Defaults to false

When true, the rule is inactive and will not be used for classification.

string
required

Transport protocol filter. Common values: 'tcp', 'udp'. Empty string to skip.

string
required

Destination port filter. Accepts single port, range, or comma-separated list. Examples: '443', '80-443', '22,80,443'. Empty to skip.

string
required

Source port filter. Accepts single port, range, or comma-separated list. Mutually exclusive with either_port. Empty to skip.

string
required

Matches traffic with port in either direction. Mutually exclusive with src_port/dst_port. Empty to skip.

string
required

Destination IPv4 filter. Accepts CIDR notation or range. Examples: '10.0.0.0/8', '192.168.1.1-254'. Comma-separated for multiple. Empty to skip.

string
required

Source IPv4 filter. Accepts CIDR notation or range. Mutually exclusive with either_ip. Empty to skip.

string
required

Matches traffic with IP in either direction. Mutually exclusive with src_ip/dst_ip. Empty to skip.

string
required

Destination DNS/domain filter. Supports wildcards (e.g., '*.example.com'). Mutually exclusive with either_dns. Empty to skip.

string
required

Source DNS/domain filter. Supports wildcards. Mutually exclusive with either_dns. Empty to skip.

string
required

Matches traffic with DNS in either direction. Mutually exclusive with src_dns/dst_dns. Empty to skip.

string
required

Destination SaaS service filter. Use service name or organization identifier. Empty to skip.

string
required

Source SaaS service filter. Mutually exclusive with either_service. Empty to skip.

string
required

Matches traffic with service in either direction. Mutually exclusive with src_service/dst_service. Empty to skip.

string
required

Destination geographic location filter. Use country/region codes (e.g., 'US', 'EU'). Empty to skip.

string
required

Source geographic location filter. Mutually exclusive with either_geo. Empty to skip.

string
required

Matches traffic with geo location in either direction. Mutually exclusive with src_geo/dst_geo. Empty to skip.

string
required

VLAN/interface filter for matching traffic on specific network segments. Empty to skip.

string
required

DSCP (Differentiated Services Code Point) filter. Values 0-63 for QoS marking match. Empty to skip.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json