/api/v0/pin/remote/ls

List objects pinned to remote pinning service.

Arguments

• service [string]: Name of the remote pinning service to use (mandatory). Required: no.

• name [string]: Return pins with names that contain the value provided (case-sensitive, exact match). Required: no.

• cid [array]: Return pins for the specified CIDs (comma-separated). Required: no.

• status [array]: Return pins with the specified statuses (queued,pinning,pinned,failed). Default: [pinned]. Required: no.

Response

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

{
  "Cid": "<string>",
  "Name": "<string>",
  "Status": "<string>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/pin/remote/ls?service=<value>&name=<value>&cid=<value>&status=[pinned]"