Skip to main content
GET
Resolve IPNS name
Resolves an IPNS name (a mutable pointer) to the immutable cid it currently references. Use the returned CID with the other IPFS endpoints (resolve, stat, ls).
Requires the IPFS add-on (X-Api-Key). Node-only; returns 503 if the self-hosted node is unavailable.
Example

Authorizations

X-Api-Key
string
header
required

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

name
string
required
Maximum string length: 500

Response

200 - application/json

OK

name
string
cid
string