BPQL Object Syntax

Several endpoints take a bpql parameter — a BigPanda Query Language (BPQL) filter expressed as a JSON object. This is different from the BPQL string form used to search and filter inside the BigPanda UI. Use the JSON object form described here whenever an endpoint requires a bpql parameter, for example when creating a maintenance plan.

For the string form used in the console, see the BigPanda Query Language (BPQL) documentation.

Basic query

A basic query pairs an operator with a tag and a value:

{ "<operator>": ["<tag>", "<value>"] }

Operator	BPQL string	BPQL object
equal	`host = prod-api-1`	`{"=": ["host", "prod-api-1"]}`
not equal	`host != prod-api-1`	`{"!=": ["host", "prod-api-1"]}`
strong equal	`host === prod-api-1`	`{"===": ["host", "prod-api-1"]}`
in	`host IN [prod-api-1,prod-api-2]`	`{"IN": ["host", ["prod-api-1", "prod-api-2"]]}`
not in	`host NOT IN [prod-api-1,prod-api-2]`	`{"NOT IN": ["host", ["prod-api-1", "prod-api-2"]]}`

Complex query

Combine sub-queries with AND or OR:

{ "AND": [
  {"=": ["host", "prod-api-1"]},
  {"=": ["check", "cpu"]}
] }

Special values

Wildcards and regex use a typed value object:

Form	Example string	Example object
Wildcard	`host = prod-api-*`	`{"=": ["host", {"type": "regex", "value": "prod-api-*"}]}`
Regex	`host = /prod-api-.*/`	`{"=": ["host", {"type": "formal-regex", "value": "prod-api-.*"}]}`

Wildcard limitation for environments
Environment conditions do not support wildcards with the IN and NOT IN operators.

Next steps

Pagination: Combine filters with paging on query endpoints.

Expandable objects: Inline related objects in filtered results.

Making requests: Review request conventions.

Basic query#

Complex query#

Special values#

Next steps#

Basic query

Complex query

Special values

Next steps