Skip to main content

IPFS Pinning Service API

Not to be confused with the Fula API, the Pinning Service API allows you to create a link between your local IPFS node and Functionland Fula Network

IPFS Pinning Services API Spec Compatibility

The IPFS Pinning Services API Spec is a standardized specification for developers building on top of IPFS that allows an application to integrate a pinning service without needing to learn that pinning service's unique API.

Introduction

Functionland Fula network is the only available true decentralized network for pinning ipfs data. It currently includes 900 globally distributed nodes. These nodes are individually owned and are rewarded using Fula blockchain based on the storage they provide. Since it is an open network, anyone can join and start providing the service and earns. For more information please visit https://fx.land

Endpoints

Functionland Fula users looking to utilize the IPFS Pinning Services API can do so from our dedicated API endpoint:

https://api.cloud.fx.land

Authentication

To authenticate with Functionland through the Pinning Services API spec, you'll first need to have an accessToken. You can create this API token on the Fula Cloud Page (FREE 20GB pinning!)

If you ever revoke the API key, it will no longer be valid for authenticating to the Pinning Services API.

Configuring Functionland Fula in the IPFS Desktop App

If you are running the IPFS desktop app, you can configure your pinning service of choice within the user interface. To do so, open the app, go to your Preferences, then click Add Service:

Select Functionland as the pinning service, and then configure with your secret access token (JWT):

From there you can upload files and have the option to pin locally as well as remotely to Functionland Fula network!

Configuring Functionland Fula in the IPFS CLI

You can also pin to Functionland Fula directly from the IPFS CLI using the ipfs command.

To add Functionland Fula credentials, use the following command (where YOUR_JWT is the JWT token described in the “Authentication” section above):

ipfs pin remote service add functionland https://api.cloud.fx.land YOUR_JWT

To pin a CID to Functionland Fula under a human-readable name:

ipfs pin remote add --service=functionland --name=war-and-peace.txt bafybeib32tuqzs2wrc52rdt56cz73sqe3qu2deqdudssspnu4gbezmhig4

To list successful pins:

ipfs pin remote ls --service=functionland

To list pending pins:

ipfs pin remote ls --service=functionland --status=queued,pinning,failed

For more commands and general help:

ipfs pin remote --help