NavigationContentFooter

IPFS Pinning service API

Introduction

The InterPlanetary File System (IPFS) is a modular suite of open data storage and exchange protocols. Anybody can participate in this peer-to-peer network. In mid-2022 more than 300K nodes were a part of the network. Content stored on IPFS nodes is powered by a content-addressing design, making it location-agnostic, verifiable, and immutable. This design makes IPFS a good choice for versioning, archiving, NFT, or ample content storage and distribution.

Scaleway pinning service enables you to keep (to 'pin') your data always available on the public IPFS network. Our pinning service is available in all of our regions to increase the accessibility of your data.

Concepts

Refer to our to find definitions of all IPFS-related terminologies.

Quickstart

Refer to our dedicated to begin using the service.

You can also find a tutorial on and .

You can find also detailed explainations on .

Technical information

The Scaleway IPFS pinning service provides features such as:

  • Unlimited storage via our Object Storage backend
  • Possibility to pin a remote content by an URL

Data privacy

  • Data is public: our IPFS nodes are bootstrapped with public IPFS nodes. This implies that any pinned content will be available on the public IPFS network
  • Data is shared: public IPFS nodes can fetch and host your pinned content. Your data could be hosted anywhere (France, Europe, America, the Moon...). Scaleway is not enabled to delete once a content is delivered to external peers
  • Data is not encrypted: be aware that we do not apply any encryption algorithm over your data

In consequence, consider to pin public-compatible data and/or encrypt by your own your content.

0% SLA

We strive to provide you with the best possible experience on our IPFS pinning. However, this is an experimental service. This is why we are not able to contractually commit to a level of service, hence an SLA of 0%. The guarantees of these "Labs" offers are detailed in our special conditions for BETA services.

Clients

The Scaleway IPFS Pinning service is available on different clients:

  • Scaleway CLI to and

Regions

Scaleway's infrastructure is spread across different .

Scaleway IPFS pinning service is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:

  • fr-par
  • nl-ams
  • pl-waw.

Pins

A pin is an abstract object that holds a Content Identifier (CID). It is defined that during the lifespan of a pin, the CID (and all sub-CIDs) must be hosted by the service It is possible that many pins target the same CID, regardless of the user.

GET
/ipfs/v1alpha1/regions/{region}/pins
GET
/ipfs/v1alpha1/regions/{region}/pins/{pin_id}
DELETE
/ipfs/v1alpha1/regions/{region}/pins/{pin_id}
POST
/ipfs/v1alpha1/regions/{region}/pins/{pin_id}/replace
POST
/ipfs/v1alpha1/regions/{region}/pins/create-by-cid
POST
/ipfs/v1alpha1/regions/{region}/pins/create-by-url

Volumes

A volume is bucket of pins. It is similar to an Object Storage bucket. Volumes are useful to gather pins with similar lifespans All pins must be attached to a volume. And all volumes must be attached to a Project ID.

GET
/ipfs/v1alpha1/regions/{region}/volumes
POST
/ipfs/v1alpha1/regions/{region}/volumes
GET
/ipfs/v1alpha1/regions/{region}/volumes/{volume_id}
PATCH
/ipfs/v1alpha1/regions/{region}/volumes/{volume_id}
DELETE
/ipfs/v1alpha1/regions/{region}/volumes/{volume_id}
Cloud Products & Resources
Dedicated Products & Resources
Scaleway
Follow us
© 1999-2024 – Scaleway SAS