List IPFS directory
IPFS
List IPFS directory
List the entries (links) of a directory / DAG CID.
GET
List IPFS directory
Lists the immediate entries under a directory or DAG CID — each with
name, cid,
size, and type (file or dir). Ideal for browsing NFT-collection folders or
multi-file uploads. Results are capped (truncated: true when the directory exceeds
the server limit).
Requires the IPFS add-on (
X-Api-Key). Node-only; returns 503 if the
self-hosted node is unavailable.Example
Authorizations
API key (programmatic access — recommended)
Send your API key in the X-Api-Key header. Keys start with nxs_ and are
created in the dashboard (or via POST /api/keys with a session JWT).
Each key is scoped to one chain and one network (for example
cardano-mainnet), fixed at creation time. It cannot query a different network
on the same chain, and it cannot query a different chain at all. A mismatched
network parameter returns 400 Network Mismatch. Create one key per chain
and network under the same account.
This is the credential most integrations should use.
Query Parameters
Maximum string length:
500