Search
Developers can search the portal from the header. Queries return published pages, API specifications they can access, and documentation — then open the matching item.
Where to find it
On large screens the search field is in the header. On smaller screens, use the search icon.
Using search
- Shortcut —
⌘K(Mac) orCtrl+K(Windows/Linux) focuses the header field.Escapecloses the dropdown. - Dropdown — results are labeled Page, API Spec, or Documentation. Arrow keys move the selection; Enter opens it.
- Suggestions — matching titles as you type. Choosing one opens the full results view for that phrase.
- Recent Searches — this browser only. They appear when the field is focused and empty. Clear them with the × on that list.
- View all results — opens the full results view for the current query.
The search page
The full results view is available from the header dropdown or the search icon. Filter by All, Page, API Spec, or Documentation. Results are grouped by type.
What is searched
- Pages — published Page Builder pages
- API Specs — API specifications the visitor is allowed to see
- Documentation — documentation published in the portal
Draft pages are not included. Spec results follow role-based access.
Endpoint search is in the spec viewer
Searching inside an OpenAPI document (operations, parameters, schemas) is the search in
Interactive API Docs, not header search. Header search
finds the spec as a whole.
Rebuild the index
After you publish or change a lot of pages, specs, or docs, open Configuration → Search (requires Manage Search).
- Open the Search section.
- Click Rebuild Search Index to refresh searchable published pages, API specifications, and documentation.
Rebuild can take a few moments on a large catalog. When it finishes, new and updated content is searchable.