> For the complete documentation index, see [llms.txt](https://help.highlight.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.highlight.net/admin/admin-general-details/admin-search.md).

# Admin Search

This page describes Admin Search.  See [Tree Search](/getting-started/useful-information/searching.md) for an alternative method.

Simply describe what you are looking for in plain English and the results show just the matching items. Search across a wide range of attributes, not just names: what something is, how it is configured, and its current state. 

Combine searches with semi-colon delimited conditions such as *dormant watches; watches with an upstream of > 100MB; cameras*. 

You can also save the searches you run most often and recall them in a click.

<figure><picture><source srcset="/files/UiZbFE87ZQuobDcPyyuV" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FHcYvEKbol2zM7xmiygop%2FSearch%20example%20-%20light.png?alt=media&amp;token=a3360ef2-2bf0-435a-aa87-c6bf56bba20f" alt="Search example"></picture><figcaption></figcaption></figure>

<table><thead><tr><th width="108">Item</th><th>function</th></tr></thead><tbody><tr><td>input box </td><td>describe what you are looking for in plain English</td></tr><tr><td>star</td><td>use to save a search and to remove a saved search</td></tr><tr><td>x</td><td>use to clear a search input</td></tr><tr><td><strong>Go</strong> button</td><td>use to run a search - Return also works</td></tr><tr><td>cog</td><td>open the item to view or edit, if you have the relevant permission</td></tr><tr><td>arrow</td><td>jump straight to any match in the hierarchy</td></tr></tbody></table>

**example:  containers&#x20;**~~**with**~~**&#x20;maintenance**

Text may be struck through to indicate it's not needed for the search.  So, in the above example, "containers maintenance" works the same as "containers with maintenance"&#x20;

**example:  5 items found**

A bar appears under the search criteria showing the total items found and to indicate the results list below is filtered. &#x20;

{% hint style="success" %}
**No matching items**

Searches returning "No matching items" are logged and reviewed to see if the search function can be improved
{% endhint %}

{% hint style="info" icon="earth-europe" %}
**Geographic searching**

The search functionality allows for "locations in the UK" or "watches in the US".  This is based on the time zone setting on the location or watch's location and is in beta.  &#x20;
{% endhint %}

### Examples and Saved Searches

Click into the search bar to see any saved searches followed by a list of example searches.

<figure><picture><source srcset="/files/cVhE6cHmZnUud0OCzmme" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F1BzplQ8RpLTuxsPG1Xqx%2FAdmin%20Search%20Examples%20-%20light.png?alt=media&amp;token=8fb1c92c-2d2f-4f15-a59b-ba657c27fccd" alt="Admin Search Examples"></picture><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.highlight.net/admin/admin-general-details/admin-search.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.