Endpoint reference

Generated from docs/openapi.yaml — ADAMANT IPFS Node API, contract version 0.1.0.

This page lists the stable client, lifecycle, and node-health contract. Low-level Helia, libp2p, and optional debug operator routes are intentionally left out of the specification; they are described in Administrative and debug routes.

Download the machine-readable specification: openapi.yaml.

Operations

Operation	Summary	Authentication
GET /api/node/health	Read the network-aware node checkpoint	Public
GET /api/node/info	Read sanitized legacy PWA and iOS node information	Public
GET /api/node/details	Read detailed operator state	x-api-key
POST /api/file/upload	Upload one or more files	Public
GET /api/file/{cid}	Download a complete content-addressed file	Public
GET /api/file/{cid}/status	Read public lifecycle and replication counts	Public
POST /api/file/{cid}/confirm	Promote a temporary file to durable storage	x-api-key
POST /api/file/{cid}/unpin	Release durable content	x-api-key
GET /api/storage/metrics	Read public bounded storage and replication counts	Public
GET /api/storage/policy	Read upload, lifecycle, and durability policy	Public
POST /api/storage/gc	Run or preview garbage collection	x-api-key
POST /api/storage/repair	Run the next bounded replication repair batch	x-api-key

Details

GET /api/node/health

Read the network-aware node checkpoint

Authentication: Public

Status	Meaning
200	The current state; inspect the state field because this route is always 200

GET /api/node/info

Read sanitized legacy PWA and iOS node information

Authentication: Public

Status	Meaning
200	Legacy node information

GET /api/node/details

Read detailed operator state

Authentication: x-api-key

Status	Meaning
200	Node identity, storage, health, and bounded HTTP metrics
401	Unauthorized
503	AdminNotConfigured

POST /api/file/upload

Upload one or more files

Authentication: Public

Status	Meaning
200	Files were stored and pinned
400	BadRequest
413	Request or file limit exceeded
429	Upload rate or concurrency limit exceeded
503	Required replication quorum was not reached
507	The disk reserve would be consumed

GET /api/file/{cid}

Download a complete content-addressed file

Range headers are ignored and return the complete 200 representation

Authentication: Public

Status	Meaning
200	Complete file attachment
304	The validated CID representation has not changed
400	BadRequest
408	Discovery or complete retrieval timed out
429	Read rate, per-client, or global download concurrency limit exceeded

GET /api/file/{cid}/status

Read public lifecycle and replication counts

Authentication: Public

Status	Meaning
200	File lifecycle state
404	Unknown CID

POST /api/file/{cid}/confirm

Promote a temporary file to durable storage

Authentication: x-api-key

Status	Meaning
200	File confirmed
401	Unauthorized
404	Unknown CID

POST /api/file/{cid}/unpin

Release durable content

Authentication: x-api-key

Status	Meaning
200	File released for later collection
401	Unauthorized
404	Unknown CID

GET /api/storage/metrics

Read public bounded storage and replication counts

Authentication: Public

Status	Meaning
200	Cached storage metrics

GET /api/storage/policy

Read upload, lifecycle, and durability policy

Authentication: Public

Status	Meaning
200	Public storage policy

POST /api/storage/gc

Run or preview garbage collection

Authentication: x-api-key

Parameter	In	Required	Description
dryRun	query	no

Status	Meaning
200	Garbage collection report
401	Unauthorized
409	Garbage collection is already running

POST /api/storage/repair

Run the next bounded replication repair batch

Authentication: x-api-key

Status	Meaning
200	Repair batch and cycle progress
401	Unauthorized
409	Replication repair is already running