Open topic with navigation

# Parameters for Client Filtering

You can filter requests for client status objects to narrow the collection of clients.

Filtering is available as part of any client status object method. For background information, see Filters for Client Status Methods.

- You can filter the list by length.
- You can filter the list by comparing the relative values of client id numbers.
- You can filter on any of the JSON attributes of client status objects.

The following table suggests some of the most useful HTTP parameters for filtering.

Syntax | Description
--- | ---
`limit=<max>` | Optional. When present, return at most <max> objects. When absent, retrieve the entire list.
`before=<num>` | Optional. When present, return only those clients with id less than <num>.
`after=<num>` | Optional. When present, return only those clients with id greater than <num>.
app_name=<name> | Optional. When present, return only those clients with this application name.
user=<user_name> | Optional. When present, return only those clients with this username.
host=<host_name> | Optional. When present, return only those clients running on the computer with this host name.
ip=<ip_addr> | Optional. When present, return only those clients running on the computer with this IP address.
status=<status> | Optional. When present, return only those clients with this operating status. Specify one of the following integer <status> values: Running Needs restart Timed out Exception Out of synch

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO FTL® - Enterprise Edition

Copyright © 2009-2024. Cloud Software Group, Inc. All Rights Reserved.