Skip to content

Add REST API endpoints for crawler management #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Terrtia merged 3 commits into from
Mar 18, 2026
Merged

Add REST API endpoints for crawler management #325

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6db13bd
Add REST API endpoints for crawler scheduler, captures, stats, and bl…
cln-io Mar 16, 2026
e8e1e8b
Fix JSON serialization for scheduler tags and delete error payloads
cln-io Mar 16, 2026
2a0ed60
Rename blacklist API routes to blocklist
cln-io Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions var/www/blueprints/api_rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,57 @@ def lacus_cookiejar_import():
return Response(json.dumps(res[0]), mimetype='application/json'), res[1]


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# # # # # # # # # # # # CRAWLER SCHEDULER / STATS # # # # # # # # # # # # # #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

@api_rest.route("api/v1/crawler/scheduler", methods=['GET'])
@token_required('user')
def get_crawler_scheduler():
res = crawlers.get_schedulers_metas()
return create_json_response(res, 200)
Comment thread
cln-io marked this conversation as resolved.

@api_rest.route("api/v1/crawler/schedule/<path:schedule_uuid>", methods=['DELETE'])
@token_required('admin')
def delete_crawler_schedule(schedule_uuid):
data = {'uuid': schedule_uuid}
res = crawlers.api_delete_schedule(data)
return create_json_response(res[0], res[1])
Comment thread
cln-io marked this conversation as resolved.
Outdated

@api_rest.route("api/v1/crawler/captures/status", methods=['GET'])
@token_required('user')
def get_crawler_captures_status():
res = crawlers.get_captures_status()
return create_json_response(res, 200)

@api_rest.route("api/v1/crawler/stats", methods=['GET'])
@token_required('user')
def get_crawler_stats():
domain_type = request.args.get('domain_type')
res = crawlers.get_crawlers_stats(domain_type=domain_type)
return create_json_response(res, 200)

@api_rest.route("api/v1/crawler/blacklist", methods=['GET'])
@token_required('admin')
def get_crawler_blacklist():
res = crawlers.get_blacklist()
return create_json_response(list(res), 200)

@api_rest.route("api/v1/crawler/blacklist", methods=['POST'])
@token_required('admin')
def add_crawler_blacklist():
data = request.get_json()
res = crawlers.api_blacklist_domain(data)
Comment thread
cln-io marked this conversation as resolved.
return create_json_response(res[0], res[1])

@api_rest.route("api/v1/crawler/blacklist/<path:domain>", methods=['DELETE'])
@token_required('admin')
def delete_crawler_blacklist(domain):
data = {'domain': domain}
res = crawlers.api_unblacklist_domain(data)
return create_json_response(res[0], res[1])


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# # # # # # # # # # # # # # IMPORTERS # # # # # # # # # # # # # # # # #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
Expand Down