Skip to content

enrichment ​

6 endpoints at a glance
MethodPathSummary
GET/admin/enrichment/Enrichment Summary
POST/admin/enrichment/discoverRun Discovery
POST/admin/enrichment/discover-deepRun Deep Discovery
POST/admin/enrichment/recoverRecover
POST/admin/enrichment/refreshForce Refresh
GET/admin/enrichment/targetsList Targets

enrichment​


Enrichment Summary​

GET
/admin/enrichment/

Ledger rollup + today's shared IPLocate budget + worker
snapshot. Drives the admin panel header.

Parameters​

Header Parameters

authorization
x-api-key

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers

Samples​


List Targets​

GET
/admin/enrichment/targets

Paginated ledger rows, newest-seen first. Optional type
(ip/asn/host) and status filters.

Parameters​

Header Parameters

authorization
x-api-key

Query Parameters

type
status
limit
Type
integer
Default
100
skip
Type
integer
Default
0

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers
Variables
Key
Value

Samples​


Force Refresh​

POST
/admin/enrichment/refresh

Make matching ledger rows due now (manual staleness bust).

Parameters​

Header Parameters

authorization
x-api-key

Request Body​

application/json
JSON
{
  
"entity_id": "string",
  
"type": "string",
  
"hard": false
}

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers
Body

Samples​


Run Discovery​

POST
/admin/enrichment/discover

Run the discovery scan now (off the event loop — it's blocking
Mongo work).

Parameters​

Header Parameters

authorization
x-api-key

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers

Samples​


Run Deep Discovery​

POST
/admin/enrichment/discover-deep

Run the phase-2 deep scan now (traceroute hop IPs + DNS A/AAAA
answers out of measurements_latest).

Bounded + incremental like the scheduled job — one tick processes
up to EnrichmentSettings.DEEP_SCAN_DOC_CAP new rows and
advances the watermark, so repeated clicks walk the backlog.
Off the event loop (heavier blocking Mongo work). The only
on-demand trigger when the scheduler is disabled (it otherwise
only runs via ENRICHMENT_DEEP_SCAN_CRON).

Parameters​

Header Parameters

authorization
x-api-key

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers

Samples​


Recover​

POST
/admin/enrichment/recover

Requeue ledger rows stranded in running (worker crashed
mid-item).

Parameters​

Header Parameters

authorization
x-api-key

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers

Samples​


Atlas — built on RIPE Atlas data.