Wetez
  • Hello
  • Invite Wetez
  • User
    • Staking
      • Polygon
      • Cosmos
      • Oasis
      • Mina
      • Evmos
      • Tezos
      • Solana
      • Kava
      • Akash
      • Juno
      • IRISnet
      • Ethereum
      • IoTex
      • Wanchain
      • Gravity Bridge
      • Meter
      • ChainX
      • Edgeware
      • Debio Network
      • Myriad
      • IOST
      • Rebus
      • Teritori
      • Carbon
      • Canto
      • OmniFlix(Coming soon)
      • Projects inactive
        • Polkadot
        • Nym Mixnode
        • Polkadex
        • Findora
        • Sifchain
        • Alaya
        • NFTmart
        • Umee
    • Metamask RPCs
    • IPFS Pinning
  • Developer
    • Appchain
      • Cosmos SDK Chain
      • Substrate Independent Chain
      • Polkadot Parachain
      • Polygon Edge Chain
      • Ethereum Rollups
      • Avalanche Subnet
      • Oasis Paratime
      • BNB Sidechain
    • APIs
      • Ethereum Mainnet
      • Solana Mainnet
      • Polygon Mainnet
      • Arbitrum Mainnet
      • Tendermint Mainnet
      • Error
    • Storage
      • IPFS
      • HTTP API methods
      • add
      • block_get
      • block_put
      • block_stat
      • cat
      • dag_get
      • dag_put
      • dag_resolve
      • get
      • pin_add
      • pin_ls
      • pin_rm
      • pin_update
      • version
Powered by GitBook
On this page
  • /api/v0/pin/ls
  • REQUEST
  • RESPONSE
  1. Developer
  2. Storage

pin_ls

Lists objects pinned to local storage.

/api/v0/pin/ls

Lists object pinned to local storage.

REQUEST

curl "https://mainnet-rpc.wetez.io/ipfs/$AdminKey/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&stream=<value>" \
    -X POST
curl "https://ipfs.infura.io:5001/api/v0/pin/ls?arg=QmfQ5QAjvg4GtA3wg3adpnDJug8ktA1BxurVqBD8rtgVjM" \
    -X POST

REQUEST PARAMS

  • arg [Required] - Path to object(s) to be listed.

  • type [Optional] - The type of pinned keys to list. Can be direct, indirect, recursive, or all. The default is all.

  • quiet [Optional] - Write just hashes of objects.

  • stream [Optional] - Enable streaming of pins as they are discovered.

RESPONSE

On success, the call to this endpoint returns with 200 and the following body:

BODY

{
  "PinLsList": {
    "Keys": {
      "<string>": {
        "Type": "string"
      }
    }
  },
  "PinLsObject": {
    "Cid": "string",
    "Type": "string"
  }
}
Previouspin_addNextpin_rm

Last updated 2 years ago