IPFS Pinning Service API
Learn how to programmatically use the IPFS Pinning Service API with Filebase.
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.
To interact with the Filebase IPFS Pinning Service API, use the following information below.

API Endpoint

https://api.filebase.io/v1/ipfs

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>
The access-token is composed of three parts:
ACCESS-KEY:SECRET-KEY:BUCKET-NAME encoded in Base64
  • Your Filebase Access Key.
  • Your Filebase Secret Access Key.
  • A Filebase IPFS bucket name you want to re-pin your CIDs to.
Then, navigate to Base64Encode and input the following information, then select 'Encode' and copy the result: ACCESS-KEY:SECRET-KEY:BUCKET-NAME

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:
{
"cid": "bafybeihbfkn5afsjep2jd65gn5vedh7vpvp6i6avfu5za7fnnhsvfutzjy",
"name": "image3",
"meta": {
"key_name": "value_name"
}
}
All parameters listed in the following API methods are JSON fields in the payload.
get
https://api.filebase.io/v1/ipfs
/pins
List pinned objects
post
https://api.filebase.io/v1/ipfs
/pins
Pin an object
get
https://api.filebase.io/v1/ipfs
/pins/{requestid}
Get pinned object
post
https://api.filebase.io/v1/ipfs
/pins/{requestid}
Replace pinned object
delete
https://api.filebase.io/v1/ipfs
/pins/{requestid}
Remove pinned object
If you have any questions, please join our Discord server, or send us an email at [email protected]