/api/v0/pin/ls

List objects pinned to local storage.

Arguments

• arg [string]: Path to object(s) to be listed. Required: no.

• type [string]: The type of pinned keys to list. Can be "direct", "indirect", "recursive", or "all". Default: all. Required: no.

• quiet [bool]: Output only the CIDs of pins. Required: no.

• name [string]: Limit returned pins to ones with names that contain the value provided (case-sensitive, partial match). Implies --names=true. Required: no.

• stream [bool]: Enable streaming of pins as they are discovered. Required: no.

• names [bool]: Include pin names in the output (slower, disabled by default). Required: no.

Response

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

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

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&name=<value>&stream=<value>&names=<value>"