List pinned objects

GET /ipfs/pin/list

List objects pinned to local storage

Hosted Endpoint only available for hosted variant.

Request

Query Parameters

count integer

Possible values: >= 1 and <= 100

Default value: 100

The number of results displayed on one page.

page integer

Possible values: >= 1 and <= 21474836

Default value: 1

The page number for listing the results.

order string

Possible values: [asc, desc]

Default value: asc

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

• 200
• 400
• 403
• 404
• 418
• 429
• 500

---

Returns pinned objects

application/json

Schema

Example (from schema)

---

Schema

• Array [
time_created integer required

Creation time of the IPFS object on our backends

time_pinned integer required

Pin time of the IPFS object on our backends

ipfs_hash string required

IPFS hash of the pinned object

size string required

Size of the object in Bytes

state string required

Possible values: [queued|pinned|unpinned|failed|gc]

State of the pinned object, which is queued when we are retriving object. If this is successful the state is changed to pinned or failed if not. The state gc means the pinned item has been garbage collected due to account being over storage quota or after it has been moved to unpinned state by removing the object pin.

• ]

[
  {
    "time_created": 1615551024,
    "time_pinned": 1615551024,
    "ipfs_hash": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx",
    "size": "1615551024",
    "state": "pinned"
  }
]

Bad request

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 400,
  "error": "Bad Request",
  "message": "Backend did not understand your request."
}

Authentication secret is missing or invalid

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 403,
  "error": "Forbidden",
  "message": "Invalid project token."
}

Component not found

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 404,
  "error": "Not Found",
  "message": "The requested component has not been found."
}

IP has been auto-banned for extensive sending of requests after usage limit has been reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 418,
  "error": "Requested Banned",
  "message": "IP has been auto-banned for flooding."
}

Usage limit reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 429,
  "error": "Project Over Limit",
  "message": "Usage is over limit."
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 500,
  "error": "Internal Server Error",
  "message": "An unexpected response was received from the backend."
}

Loading...