Pin IPFS content
IPFS
Pin IPFS content
Persist a CID on Nexus’ self-hosted node, scoped to your API key.
POST
Pin IPFS content
Pins a CID on Nexus’ self-hosted node so it stays available. The pin is recorded
against your API key and returns
Pins are reference-counted per key: see List pins and
Unpin. The node only physically unpins a CID once no
API key references it anymore — one tenant can never drop another tenant’s content.
{ cid, pinned, sizeBytes }. Idempotent — pinning
the same CID twice is a no-op.
Requires the IPFS add-on. Pinning is API-key only — a browser/cookie session
returns
403. Oversized content (above the server limit) returns 413.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