Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IPFS Pin API

The Pin API from IPFS — 11 operation(s) for pin.

IPFS Pin API is one of 40 APIs that IPFS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 11 operations across 11 paths. It is described by OpenAPI 3.0.0, at version v0.

Requests are made against 3 base URLs: http://localhost:5001, http://127.0.0.1:5001, https://ipfs.infura.io:5001.

11 operations 11 paths 0 schemas 11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0
Base URL
http://localhost:5001
Resource Areas
1

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.

Pin 11
POST
/api/v0/pin/add
Pin objects to local storage.
pin/add 3 params → 200
POST
/api/v0/pin/ls
List objects pinned to local storage.
pin/ls 4 params → 200
POST
/api/v0/pin/remote/add
Pin object to remote pinning service.
pin/remote/add 4 params → 200
POST
/api/v0/pin/remote/ls
List objects pinned to remote pinning service.
pin/remote/ls 4 params → 200
POST
/api/v0/pin/remote/rm
Remove pins from remote pinning service.
pin/remote/rm 5 params → 200
POST
/api/v0/pin/remote/service/add
Add remote pinning service.
pin/remote/service/add 1 param → 200
POST
/api/v0/pin/remote/service/ls
List remote pinning services.
pin/remote/service/ls 1 param → 200
POST
/api/v0/pin/remote/service/rm
Remove remote pinning service.
pin/remote/service/rm 1 param → 200
POST
/api/v0/pin/rm
Remove object from pin-list.
pin/rm 2 params → 200
POST
/api/v0/pin/update
Update a recursive pin.
pin/update 2 params → 200
POST
/api/v0/pin/verify
Verify that recursive pins are complete.
pin/verify 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-pin-api-openapi.yml Raw ↑

Other APIs IPFS publishes across the network.

IPFS HTTP Gateway API
IPFS Delegated Routing V1 HTTP API
IPFS Add API
IPFS Bitswap API
IPFS Block API
IPFS Bootstrap API
IPFS Cat API
IPFS Cid API
IPFS Commands API
IPFS Config API
IPFS Dag API
IPFS Dht API