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
enum<string>

Filter by the status of the job in the pinning queue

Available options:
prechecking,
retrieving,
expired,
over_free_limit,
over_max_size,
invalid_object,
bad_host_node
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[]
Pin By CIDPinning Service API