yacy_search_server/help/IndexBrowser_p.md

page, help, title, package, access, kind, backend_java

page	help	title	package	access	kind	backend_java
htroot/IndexBrowser_p.html	help/IndexBrowser_p.md	Index Browser	index-management	admin	admin-page	source/net/yacy/htroot/IndexBrowser_p.java

Index Browser

Purpose

The Index Browser is the diagnostic view for known URLs and hosts. It helps answer whether YaCy has stored a document, which host/path is involved, and what can be inspected or removed.

Use it after crawling when search results do not match expectations.

The page has three layers: a host/path browser for finding stored URLs, analysis views for link and host structure, and administration actions for removing or reloading selected data.

What You Can Do Here

• Inspect whether a host, path, or exact URL is present in YaCy's URL database.
• Work from the narrowest host, path, query, or field scope that answers the question.
• Open link-structure views to understand why a document was discovered and how it connects to other pages.
• Reload failed documents such as stored 404/load errors when the failure may have been temporary.
• Confirm destructive actions carefully because index maintenance can remove documents or start expensive reprocessing.

Page Architecture

Index pages expose stored documents through URL, host, path, Solr field, or queue views. Read-only inspection and destructive maintenance often share the same page, so the target scope matters more than the button label.

Control	Meaning	Values or examples
path	URL path, URL prefix, or host/path scope. In index tools it decides which part of the stored URL tree is inspected or changed.	URL, host/path prefix, or path scope shown by the page.
list	Requests a list view for the selected host or path scope.	Usually sent with path; the value can be left as the button value generated by the form.
delete	Deletes the selected object or scope. Use only with explicit confirmation.	Delete Subpath
reload404	Queues failed documents such as 404/load-error entries for another load attempt.	Re-load load-failure docs (404s etc)
addtoblacklist	Adds the selected URL or host pattern to the configured blacklist.	Submit only after confirming that the selected host/path should be blocked.
showlinkstructure	Shows incoming and outgoing link structure for the selected host or path.	show link graph
deleteLoadErrors	Deletes stored load-error records for the selected scope.	Delete Load Errors

Correct Use

Inspect before changing. Start with a host or path lookup, then use complete only when the shortened view hides the information you need. Use facetcount carefully: larger values give a broader host/path analysis but force YaCy to calculate more facets.

For deletion, blacklisting, and load-error cleanup, copy the target from the page rather than inventing it. A path such as example.org/docs/ and a broader host such as example.org/ can have very different effects.

Access And Safety

Administrator access is required. YaCy protects _p pages as administration pages.

Protected related endpoint(s): /IndexBrowser_p.html.

Automation And API

Page backend: source/net/yacy/htroot/IndexBrowser_p.java.

Endpoint	Method	Access	Backend
/IndexBrowser_p.html	GET	admin	source/net/yacy/htroot/IndexBrowser_p.java

Parameter Guide

The table explains values that an agent or script must set deliberately. Parameters not relevant to a task should be omitted or left at the page default.

Parameter	Meaning and valid values	Care
path	URL path, URL prefix, or host/path scope. In index tools it decides which part of the stored URL tree is inspected or changed.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
list	Requests a list view for the selected host or path scope.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
delete	Deletes the selected URL, path, or index scope. Confirm the scope first.	Can remove data, stop work, expose access, or make a broad operational change. Use only with explicit confirmation and an exact target.
reload404	Queues failed documents such as 404/load-error entries for another load attempt.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
addtoblacklist	Adds the selected URL or host pattern to the configured blacklist.	Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result.
showlinkstructure	Shows incoming and outgoing link structure for the selected host or path.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
deleteLoadErrors	Deletes stored load-error records for the selected scope.	Can remove data, stop work, expose access, or make a broad operational change. Use only with explicit confirmation and an exact target.
complete	Requests a complete listing instead of YaCy’s shortened default view.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
facetcount	Maximum number of host/path facets to calculate. Higher values give broader analysis but cost more work.	Controls the scope or format of the result. Prefer the narrowest value that answers the request.
hosts	Host list filter. Values such as crawling or error restrict the host overview to active crawl hosts or error hosts when supported.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
load	Loads the selected URL, host, or path detail view.	Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.

Example request shape:

GET /IndexBrowser_p.html?path=example.org/docs/&list=1&facetcount=50

What To Expect

The response shows the selected URL tree, host overview, or link graph. Destructive actions re-render the page after changing stored index metadata; verify the resulting scope immediately and use search to confirm whether user-visible results changed.

Related Pages

• ViewFile.html