Searching for resources

You can filter each element entry point based on a specified part of a name, comment, or IP address.

For example, all elements can be listed with GET 7.2.1/elements. You can search all elements using the 192.168.* IP address pattern with the following query:

GET 7.2.1/elements?filter=192.168.*

You can filter specifically by type using a type-specific URI. For example, this search returns a list of all host elements with ‘host’ in their names or comments:

GET 7.2.1/elements/host?filter=host

You can use query parameters to limit the scope of your searches and specify how searches match the search string.

The filter_context query parameter allows you to limit the search to the specified type of element. This parameter is useful for searching for types of elements that can group together multiple element types, such as network_elements, alias, engine_clusters, fw_clusters, ips_clusters, layer2_clusters, services, services_and_applications, tags, and situations.

For example, this search returns a list of Service elements with 'http' in their names or comments:

GET 7.2.1/elements?filter_context=services&filter=http

The exact_match query parameter allows you to exactly match the specified string. For example, this search matches only the element named 'master'. It does not match elements named 'master-89' or 'master-90'.

GET 7.2.1/elements?exact_match=true&filter=master

The case_sensitive query parameter allows you to match the capitalization specified in the search string. For example, this search matches only elements with 'HQ' in their names or comments. It does not match elements with 'hq' in their names or comments:

GET 7.2.1/elements?case_sensitive=true&filter=HQ