The IPFS Pinning Service API is a standardized API for re-pinning existing IPFS CIDs. It is often referred to as "remote" pinning or the IPFS "PSA". The IPFS PSA is used by both the IPFS CLI and IPFS Desktop application.
The IPFS development team tracks the compliance of each provider that supports the IPFS PSA to validate each implementation. Filebase is fully compliant with the IPFS PSA requirements. The official compliance report can be seen here.
Filebase supports the IPFS Pinning Service API through our IPFS Re-Pinning service. This API can be used to view pinned objects, add a new object to be pinned, or remove a pinned object.
The IPFS Pinning Service API has an effective rate limit of 100 RPS per IP address.
To interact with the Filebase IPFS Pinning Service API, use the following information below.
API Endpoint
https://api.filebase.io/v1/ipfs/pins
Authentication
To authenticate with the IPFS Pinning Service API, a token is required to be sent with each request in the HTTP headers, using the following format:
Authorization: Bearer <access-token>
Theaccess-tokencan be generated by navigating to the Filebase Access Keys page, then viewing the IPFS Pinning Service API Endpoint. Click the drop down menu for 'Choose Bucket to Generate Token', then choose the IPFS Filebase Bucket you want to use.
Then copy the generated Secret Access Token:
Payload
Request Body Schema:application/json
To interact with the IPFS Pinning Service API, you need to send a payload in the form of JSON to the API URL. The following is an example of a POST payload:
All parameters listed in the following API methods are JSON fields in the payload.
List pinned objects
GEThttps://api.filebase.io/v1/ipfs/pins
List all pinned objects; supports optional filters, if no filter is provided all successful pins are returned.
Query Parameters
Name
Type
Description
cid
Array
Returns pinned objets matching specified filters. Limit of 2000 characters per URL in browser contexts.
Example: cid=Qm1 , bafy2 , Qm3
name
String
Return pinned objects with a specific name. Default matching strategy is case-sensitive, exact match.
Example: name=ExampleObject.pdf
match
String
Customize the text matching strategy applied to the name filter. Default matching strategy is case-sensitive, exact match. Other options are partial matches, case-insensitive exact (iexact)and case-insensitive partial (ipartial) matches.
Options: "exact""iexact""partial""ipartial"
Example: match=iexact
status
Array
Return pinned objects matching a specified status.
Options: "queued""pinning""pinned""failed"
Example: status=queued,failed
before
String
Return pinned objects queued before the provided timestamp.
Example: before=2022-02-09T12:12:02Z
after
String
Return pinned objects queued after the provided timestamp.
Example: after=2022-02-09T12:12:02Z
limit
Integer
Maximum amount of results to return.
Default: 10
Example: limit=20
meta
Object
Return pinned objects that match specified metadata values passed using a string representation of a JSON object. If using a client library, encode the parameter to ensure secure transmission.
