{
  "opencollection": "1.0.0",
  "info": {
    "name": "Blockfrost.io ~ API Documentation Cardano » Accounts IPFS » Pins API",
    "version": "0.1.87"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "project_id",
      "value": "{{project_id}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "IPFS » Pins",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Blockfrost Pin an Object",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cardano-mainnet.blockfrost.io/api/v0/ipfs/pin/add/:IPFS_path",
            "params": [
              {
                "name": "IPFS_path",
                "value": "",
                "type": "path"
              },
              {
                "name": "filecoin",
                "value": "",
                "type": "query",
                "description": "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.\n"
              }
            ]
          },
          "docs": "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.\n\n**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.\n"
        },
        {
          "info": {
            "name": "Blockfrost List Pinned Objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cardano-mainnet.blockfrost.io/api/v0/ipfs/pin/list",
            "params": [
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "The number of results displayed on one page."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number for listing the results."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n"
              }
            ]
          },
          "docs": "List objects pinned to local storage\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n"
        },
        {
          "info": {
            "name": "Blockfrost Get Details About Pinned Object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cardano-mainnet.blockfrost.io/api/v0/ipfs/pin/list/:IPFS_path",
            "params": [
              {
                "name": "IPFS_path",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get information about locally pinned IPFS object\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n"
        },
        {
          "info": {
            "name": "Blockfrost Remove a IPFS Pin",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cardano-mainnet.blockfrost.io/api/v0/ipfs/pin/remove/:IPFS_path",
            "params": [
              {
                "name": "IPFS_path",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove pinned objects from local storage\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n\n**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.\n"
        }
      ]
    }
  ],
  "bundled": true
}