Files
yacy_search_server/help/IndexImportJsonList_p.md
2026-07-10 00:20:29 +02:00

3.4 KiB

page, help, title, package, access, kind, backend_java
page help title package access kind backend_java
htroot/IndexImportJsonList_p.html help/IndexImportJsonList_p.md JsonList Import import-export-federation admin admin-page source/net/yacy/htroot/IndexImportJsonList_p.java

JsonList Import

Purpose

JsonList Import reads a structured list of documents or URLs into YaCy.

Use it when another tool already prepared crawl or document metadata as JSON.

What You Can Do Here

  • JsonList Import reads a structured list of documents or URLs into YaCy.
  • Define the source, target, format, collection, and expected size before starting.
  • Monitor progress because large transfers continue beyond the initial request.

Page Architecture

Import and export pages translate external data formats into YaCy documents or move YaCy index data into another store. Most long-running actions create background work that should be monitored afterward.

Control Meaning Values or examples
file Selected or uploaded file. Text value; use the page label and surrounding context to choose the exact content.
url URL to inspect, crawl, import, or act on. URL or URL-derived value; use the exact format shown by the page.
submit Submits the form. Import JsonList File
abort File. Stop

Correct Use

Prepare source and target details before starting: file path or URL, format, collection, credentials if needed, and expected size. Imports and exports can continue in the background, so confirm progress on the related monitor or queue page.

Access And Safety

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

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

Automation And API

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

Endpoint Method Access Backend
/IndexImportJsonList_p.html GET admin source/net/yacy/htroot/IndexImportJsonList_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
file Selected or uploaded file. Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
url URL to inspect, crawl, import, or act on. Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default.
submit Submit action for the form. Its meaning depends on the surrounding fields. Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result.
abort File. 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 /IndexImportJsonList_p.html?url=...&file=...&submit=...&abort=...

What To Expect

Small operations may finish during the request; large imports, exports, harvests, and package operations usually need monitoring. Expect progress, logs, queue entries, or generated files rather than instant final search quality.

  • Related transfer work is usually reached through the import/export page for the same format, the index-pack pages, or the queue/status page that reports progress.