← Docs

HTTP API Reference

pcapai-server · 78 routes

Generated from the shipped binaries — not written by hand.

Registered is not implemented. Many of these answer 501 NOT_IMPLEMENTED on purpose, and pcapai-server does not ship in any installer — it is cargo run -p pcapai-server. The contract, the status codes and the one four-call flow that actually works live in PCAPAI-HTTP-API-Handoff.md; this table only proves which URLs the router binds.

MethodPathHandler
GET/root
GET/api/v1/admin/auditapi::admin::get_audit_logs
GET/api/v1/admin/configapi::admin::get_configuration
PUT/api/v1/admin/configapi::admin::update_configuration
GET/api/v1/admin/healthapi::admin::get_health
POST/api/v1/admin/maintenanceapi::admin::perform_maintenance
GET/api/v1/admin/statsapi::admin::get_statistics
GET/api/v1/admin/usersapi::admin::get_users
POST/api/v1/admin/usersapi::admin::create_user
DELETE/api/v1/admin/users/:user_idapi::admin::delete_user
PUT/api/v1/admin/users/:user_idapi::admin::update_user
POST/api/v1/auth/loginapi::auth::login
POST/api/v1/auth/logoutapi::auth::logout
POST/api/v1/auth/refreshapi::auth::refresh_token
GET/api/v1/capture/interfacesapi::capture::list_interfaces
GET/api/v1/capture/runsapi::capture::list_runs
POST/api/v1/capture/runsapi::capture::start_run
GET/api/v1/capture/runs/:run_idapi::capture::get_run
GET/api/v1/capture/runs/:run_id/segmentsapi::capture::list_segments
POST/api/v1/capture/runs/:run_id/stopapi::capture::stop_run
POST/api/v1/carrier/lookupapi::carrier::carrier_lookup
POST/api/v1/dns/lookupapi::netmore::dns_lookup
GET/api/v1/exports/:export_idapi::browse::get_export
GET/api/v1/filesapi::files::list_files
POST/api/v1/filesapi::files::upload_file
DELETE/api/v1/files/:file_idapi::files::delete_file
GET/api/v1/files/:file_idapi::files::get_file
POST/api/v1/files/:file_id/analyzeapi::files::analyze_file
GET/api/v1/files/:file_id/bundleapi::files::get_bundle
GET/api/v1/files/:file_id/conversationsapi::browse::conversations
POST/api/v1/files/:file_id/convertapi::files::convert_file
GET/api/v1/files/:file_id/downloadapi::files::download_file
GET/api/v1/files/:file_id/endpointsapi::browse::endpoints
POST/api/v1/files/:file_id/exportsapi::browse::create_export
POST/api/v1/files/:file_id/filtersapi::browse::create_filter
GET/api/v1/files/:file_id/ioapi::browse::io_graph
GET/api/v1/files/:file_id/packetsapi::browse::list_packets
GET/api/v1/files/:file_id/packets/:packet_noapi::browse::packet_detail
GET/api/v1/files/:file_id/packets/:packet_no/bytesapi::browse::packet_bytes
GET/api/v1/files/:file_id/packets/:packet_no/streamapi::streams::packet_stream
GET/api/v1/files/:file_id/protocol-hierarchyapi::browse::protocol_hierarchy
GET/api/v1/files/:file_id/servicesapi::files::get_service_summary
GET/api/v1/files/:file_id/services/detailsapi::files::get_service_details
GET/api/v1/files/:file_id/streams/:protocol/:indexapi::streams::follow
POST/api/v1/files/:file_id/tools/:tool_nameapi::browse::run_tool
POST/api/v1/files/bulkapi::files::bulk_operation
GET/api/v1/filters/fieldsapi::browse::filter_fields
POST/api/v1/huntsapi::library::create_hunt
POST/api/v1/hunts/:job_id/cancelapi::library::cancel_hunt
GET/api/v1/jobs/:job_idapi::jobs::get_job_status
POST/api/v1/jobs/:job_id/cancelapi::jobs::cancel_job
GET/api/v1/libraryapi::library::search_library
POST/api/v1/myipapi::netmore::my_ip
POST/api/v1/network/pingapi::netprobe::ping
POST/api/v1/network/tracerouteapi::netprobe::traceroute
GET/api/v1/openapi.jsonopenapi::openapi_json
POST/api/v1/oui/lookupapi::netprobe::oui_lookup
POST/api/v1/portscan/runsapi::portscan::start_run
GET/api/v1/portscan/runs/:run_idapi::portscan::get_run
POST/api/v1/portscan/runs/:run_id/cancelapi::portscan::cancel_run
GET/api/v1/siem/alertsapi::siem::get_alerts
GET/api/v1/siem/alerts/:alert_idapi::siem::get_alert
PUT/api/v1/siem/alerts/:alert_idapi::siem::update_alert
GET/api/v1/siem/configapi::siem::get_configuration
PUT/api/v1/siem/configapi::siem::update_configuration
GET/api/v1/siem/rulesapi::siem::get_rules
POST/api/v1/siem/rulesapi::siem::save_rule
DELETE/api/v1/siem/rules/:rule_idapi::siem::delete_rule
POST/api/v1/subnet/calcapi::netmore::subnet_calc
GET/api/v1/throughput/enginesapi::throughput::engines
POST/api/v1/throughput/runsapi::throughput::start_run
GET/api/v1/throughput/runs/:run_idapi::throughput::get_run
POST/api/v1/throughput/runs/:run_id/cancelapi::throughput::cancel_run
POST/api/v1/ws/ticketstreaming::issue_ws_ticket
GET/healthhealth_check
GET/metricsprometheus_metrics
GET/statusserver_status
GET/ws/streamstreaming::websocket_handler