Pins

Get a pin request and its status

Look up a request in the authenticated bucket. Poll queued and pinning requests with backoff until pinned or failed. A failed pin has not been retained successfully; check source availability and contact support if needed. The info object currently reports size, not a guaranteed detailed failure reason.

get/pins/{requestid}

Request

Base URL: https://api.filebase.io/v1/ipfs
URL: https://api.filebase.io/v1/ipfs/pins/{requestid}
Auth: HTTP bearer

Response

Current pin request status.

requestidstring required

Opaque request identifier used for status, replacement, and deletion. It is not a CID or UUID.

status'queued' | 'pinning' | 'pinned' | 'failed' required

queued: waiting for retrieval; pinning: retrieving content; pinned: retained successfully; failed: retention failed. Keep providers reachable until pinned.

createdstring date-time required

Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination

delegatesstring[] required

Multiaddrs of Filebase peers that can receive content over Bitswap. May be empty.

Example response

{
  "requestid": "opaque-pin-request-id",
  "status": "queued",
  "created": "2026-09-30T12:00:00Z",
  "pin": {
    "cid": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "name": "example.txt",
    "origins": [],
    "meta": {
      "app": "example"
    }
  },
  "delegates": [],
  "info": {
    "size": "0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.