pin_ls

/api/v0/pin/ls

Lists objects pinned to local storage.
Request must be authenticated.

REQUEST

1
POST https://ipfs.infura.io:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&stream=<value>
Copied!

REQUEST PARAMS

  • arg [Required] - Path to object(s) to be listed. Required: no.
  • type [Optional] - The type of pinned keys to list. Can be "direct", "indirect", "recursive", or "all". Defaults to "all".
  • quiet [Optional] - Write just hashes of objects.
  • stream [Optional] - Enable streaming of pins as they are discovered.

EXAMPLE

1
// POST
2
curl -X POST "https://ipfs.infura.io:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&stream=<value>" -u "<ProjectID>:<ProjectSecret>"
Copied!

RESPONSE

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

BODY

1
{
2
"PinLsList": {
3
"Keys": {
4
"<string>": {
5
"Type": "string"
6
}
7
}
8
},
9
"PinLsObject": {
10
"Cid": "string",
11
"Type": "string"
12
}
13
}
Copied!
Last modified 3mo ago