v1

latestOpenAPI 3.0.0MIT2026-07-17124105392.5 KB

IPFS » Pins

Get details about pinned object

Get information about locally pinned IPFS object

<p> <span class="hosted">Hosted</span> Endpoint only available for hosted variant. </p>

get/ipfs/pin/list/{IPFS_path}

Path parameters

IPFS_pathstring required

The path to the IPFS object

Response

Returns the pins pinned

time_createdinteger required

Time of the creation of the IPFS object on our backends

time_pinnedinteger required

Time of the pin of the IPFS object on our backends

ipfs_hashstring required

IPFS hash of the pinned object

sizestring required

Size of the object in Bytes

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

State of the pinned object. We define 5 states: queued, pinned, unpinned, failed, gc. When the object is pending retrieval (i.e. after /ipfs/pin/add/{IPFS_path}), the state is queued. If the object is already successfully retrieved, state is changed to pinned or failed otherwise. When object is unpinned (i.e. after /ipfs/pin/remove/{IPFS_path}) it is marked for garbage collection. State gc means that a previously unpinned item has been garbage collected due to account being over storage quota.

filecoinboolean required

Whether filecoin was used to pin the resource.

Example response

{
  "time_created": 1615551024,
  "time_pinned": 1615551024,
  "ipfs_hash": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx",
  "size": "1615551024",
  "state": "pinned"
}