Skip to content

infrastructure endpoints

GitHub Actions edited this page Jun 1, 2026 · 2 revisions

Infrastructure Endpoints

You will learn how to retrieve critical-infrastructure overlap data for feeds, list configured providers, and get per-provider detail.

What critical-infrastructure overlap is

Critical-infrastructure overlap measures how much a threat feed intersects with known critical infrastructure reference sets like DNS root servers, root certificate authorities, and similar essential services.

Overlap is categorized into tiers:

  • Hard — direct matches against critical reference feeds (e.g., DNS root servers)
  • Soft — matches against important but not strictly critical infrastructure
  • Contextual — matches against broad provider/customer hosting space (policy-dependent, not proof of a problem)

Aggregate overlap summary

GET /api/v1/sets/{name}/infrastructure

Returns the aggregate critical-infrastructure overlap summary for one feed. Includes feed size, total matched IPs, percentage, completeness status, provider-set identity, configured and missing providers, per-tier totals, positive-overlap providers, and optional ASN-context matches.

Example:

GET /api/v1/sets/firehol_level1/infrastructure

Key response fields: feed, family, feed_ips, critical_ips, percent, complete, provider_set_id, configured_providers, missing_providers, tiers, providers, and optional asn_context.

Configured providers

GET /api/v1/sets/{name}/infrastructure/providers

Returns the list of configured critical-infrastructure reference providers. This endpoint exposes provider metadata even when per-provider overlap artifacts are not yet materialized.

Example:

GET /api/v1/sets/firehol_level1/infrastructure/providers

Key response fields: array of provider objects with name, optional label, type, tier, role, source_type, source_quality, rationale, license/attribution fields, redistributability, and maintainer fields.

Per-provider overlap detail

GET /api/v1/sets/{name}/infrastructure/{provider}

Returns the overlap summary between one feed and one specific critical-infrastructure provider.

Example:

GET /api/v1/sets/firehol_level1/infrastructure/critical_dns_root_servers

Key response fields: provider, provider_set_id, feed_ips, critical_ips, and percent. The endpoint reports counts and percentage; it does not return the matched IP or range list.

Stale artifact handling

These endpoints are cache-first. They serve the published overlap artifacts that are present in the configured web artifact directory. Public requests do not regenerate missing or stale critical-infrastructure artifacts.

The daemon checks critical-infrastructure artifact consistency during pipeline and integrity work. If the configured provider set changes, the operator-facing integrity/admin surfaces are the place to confirm repair status.

Feeds without comparison targets

Critical reference feeds and provider-context feeds do not get comparison targets. The infrastructure endpoints return 404 for these feeds because they are the reference set, not the feeds being compared against the reference.

IPv6 feeds also do not receive critical-infrastructure overlap artifacts in the current version.

Getting Started

Installation

Running the Daemon

Configuration

Feed Configuration

Pipeline

Admin UI

Integrity

API Reference

Monitoring

CLI Tools

Troubleshooting

Updating

Catalog Maintenance

Security

Reference

Clone this wiki locally