ScopedUuid
stringMatch 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
objectThe 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
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}$
Single select filters
objectThe type of filter to apply.
Allowed values:=!=
The ID 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}$
Filter by consumer
One OfThe field to filter.
Allowed values:consumer
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
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}$
Filter by control_plane
One OfThe field to filter.
Allowed values:control_plane
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
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}$