Wildcard filters

object
operatorstringrequired

The type of filter to apply. starts_with filters will limit the results to those that start with the specified value. ends_with will limit the results to those that end with the specified value.

Allowed values:starts_withends_with

valuestringrequired

The value to include in the results

Example

Filter by auth_type

One Of
fieldstringrequired

The field to filter.

Allowed values:auth_type

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.

Example

Filter by client_ip

One Of
fieldstringrequired

The field to filter.

Allowed values:client_ip

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.

Example

ScopedUuid

string

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}$

Multiselect filters

object
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}$

Example