PlatPhorm Atlas

API documentation

The working PlatPhorm Atlas surface: ingest JA4-family observations, browse public-safe telemetry, look up fingerprints, inspect sensors, and use the same operations through MCP. Public responses redact IP addresses and secret-bearing metadata.

Public reads
No key required.
Health, counts, redacted observations, fingerprints, sensors, topology, discovery files, and MCP introspection.
Protected writes
PLATPHORM_API_KEY required.
Authorization: Bearer PLATPHORM_API_KEYX-PlatPhorm-API-Key: PLATPHORM_API_KEY
Response boundary
One envelope for REST.
{ "ok": true, "data": {} }{ "ok": false, "error": { "code": "", "message": "" } }
Implemented operations
This list is rendered from the same OpenAPI object served by the machine-readable routes.
get
/api/health

Inspect Atlas health

public
get
/api/v1/health

Inspect Atlas health through the versioned alias

public
get
/api/stats

Read persisted Atlas counts

public
get
/api/observations

List public-safe observations

public
get
/api/fingerprints

List catalogued fingerprints

public
post
/api/fingerprints/label

Create or update a fingerprint label

key required
get
/api/lookup

Correlate one fingerprint

public
get
/api/sensors

List observation sensors

public
get
/api/ja4/validate

List supported JA4-family formats

public
post
/api/ja4/validate

Validate a JA4-family fingerprint

public
get
/api/ingest/http

Inspect HTTP ingest requirements

public
post
/api/ingest/http

Ingest one observation

key required
get
/api/ingest/batch

Inspect batch ingest requirements

public
post
/api/ingest/batch

Ingest a bounded observation batch

key required
get
/api/ingest/zeek

Inspect Zeek ingest requirements

public
post
/api/ingest/zeek

Ingest Zeek records

key required
get
/api/ingest/suricata

Inspect Suricata ingest requirements

public
post
/api/ingest/suricata

Ingest Suricata EVE records

key required
get
/api/ingest/syslog

Inspect syslog ingest requirements

public
post
/api/ingest/syslog

Ingest syslog records

key required
get
/api/mcp

Inspect MCP metadata and usage

public
post
/api/mcp

Send a JSON-RPC 2.0 request or batch

public
get
/api/v1/network/graph

Read the canonical PlatPhormNews network graph

public
get
/api/v1/network/sites

List sites from the canonical network graph

public
get
/api/v1/network/trusted-domains

Read Atlas trusted-domain policy

public