Filter by realm

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[string]required

The IDs to include in the results.

Match pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

fieldstringrequired

The field to filter.

Allowed values:realm

Example

Filter by response_source

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[string]required

The values to include in the results.

fieldstringrequired

The field to filter.

Allowed values:response_source

Example

Filter by route

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[string]required

The IDs to include in the results. Because gateway IDs are only unique within a given control plane, the filter values must be of the form control_plane_id:field_id or control_plane_group_id:field_id for data plane nodes within a control plane group.

Match pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

fieldstringrequired

The field to filter.

Allowed values:route

Example

Filter by status_code

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[integer]required

The codes to include in the results.

>= 0<= 999

fieldstringrequired

The field to filter.

Allowed values:status_code

Example

Filter by status_code_grouped

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[string]required

The code groups to include in the results.

Match pattern:^\d[xX][xX]$

fieldstringrequired

The field to filter.

Allowed values:status_code_grouped

Example