v1

latestOpenAPI 3.0.0MIT2026-07-17124105392.5 KB

IPFS » Pins

Pin an object

Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.

Note: If the object was pinned to Filecoin (using filecoin=true), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.

post/ipfs/pin/add/{IPFS_path}

Path parameters

IPFS_pathstring required

Path to the IPFS object

Query parameters

filecoinboolean

If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS. Objects pinned to Filecoin cannot be unpinned due to its long-term storage guarantees.

Response

Returns pinned object

ipfs_hashstring required

IPFS hash of the pinned object

state'queued' | 'pinned' | 'unpinned' | 'failed' | 'gc' required

State of the pin action

filecoinboolean required

Whether filecoin was used to pin the resource.

Example response

{
  "ipfs_hash": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8",
  "state": "queued"
}