Filter by control_plane_group

object
dimensionstringrequired

The dimension to filter. This will be deprecated in favor of field.

Allowed values:control_plane_group

typestringrequired

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

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

Example

Filter by data_plane_node

object
dimensionstringrequired

The dimension to filter. This will be deprecated in favor of field.

Allowed values:data_plane_node

typestringrequired

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

valuesarray[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}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example

Filter by gateway_service

object
dimensionstringrequired

The dimension to filter. This will be deprecated in favor of field.

Allowed values:gateway_service

typestringrequired

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

valuesarray[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}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example

Filter by route

object
dimensionstringrequired

The dimension to filter. This will be deprecated in favor of field.

Allowed values:route

typestringrequired

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

valuesarray[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}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example

Filter by status_code

object
dimensionstringrequired

The dimension to filter. This will be deprecated in favor of field.

Allowed values:status_code

typestringrequired

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

valuesarray[integer]required

The codes to include in the results.

>= 0<= 999

Example