GET
/
pinning
/
pinJobs
curl --request GET \
  --url https://api.pinata.cloud/pinning/pinJobs \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "rows": [
    {
      "id": "<string>",
      "ipfs_pin_hash": "<string>",
      "date_queued": "<string>",
      "name": "<string>",
      "status": "<string>",
      "keyvalues": "<any>",
      "host_nodes": [
        "<string>"
      ],
      "pin_policy": {
        "regions": [
          {
            "id": "<string>",
            "desiredReplicationCount": 123
          }
        ],
        "version": 123
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort
string

Values include ASC or DESC

status
string

"status" - Filter by the status of the job in the pinning queue (see potential statuses below) "prechecking" - Pinata is running preliminary validations on your pin request. "searching" - Pinata is actively searching for your content on the IPFS network. This may take some time if your content is isolated. "retrieving" - Pinata has located your content and is now in the process of retrieving it. "expired" - Pinata wasn't able to find your content after a day of searching the IPFS network. Please make sure your content is hosted on the IPFS network before trying to pin again. "over_free_limit" - Pinning this object would put you over the free tier limit. Please add a credit card to continue pinning content. "over_max_size" - This object is too large of an item to pin. If you're seeing this, please contact us for a more custom solution. "invalid_object" - The object you're attempting to pin isn't readable by IPFS nodes. Please contact us if you receive this, as we'd like to better understand what you're attempting to pin. "bad_host_node" - You provided a host node that was either invalid or unreachable. Please make sure all provided host nodes are online and reachable

ipfs_pin_hash
string

CID of the file to be pinned

limit
integer

Number of jobs to return. Default is 5 and 1000 is the maximum

offset
integer

Provide the record offset for records being returned. This is how you retrieve records on additional pages (default is 0)

Response

200 - application/json
count
integer
rows
object[]