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 pins API

The pins API from IPFS — 2 operation(s) for pins.

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

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

This API exposes 5 operations across 2 paths, and defines 10 schemas. 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.

5 operations 2 paths 10 schemas 1 DELETE2 GET2 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

pins 5
GET
/pins
List pin objects
getPins 8 params → 2004004014044094XX5XX
POST
/pins
Add pin object
addPin body → 2024004014044094XX5XX
GET
/pins/{requestid}
Get pin object
getPinByRequestId 1 param → 2004004014044094XX5XX
POST
/pins/{requestid}
Replace pin object
replacePinByRequestId 1 param body → 2024004014044094XX5XX
DELETE
/pins/{requestid}
Remove pin object
deletePinByRequestId 1 param → 2024004014044094XX5XX

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PinStatus (6 properties), Pin (4 properties), PinResults (2 properties), Failure (1 property). Each schema is shown below with its type and property counts.

StatusInfo
object
Optional info for PinStatus response
PinMeta
object
Optional metadata for pin object
TextMatchingStrategy
string
Alternative text matching strategy
PinResults
object
Response used for listing pin objects matching request
2 properties 2 required
Failure
object
Response for a failed request
1 property 1 required
PinStatus
object
Pin object with status
6 properties 5 required
Delegates
array
List of multiaddrs designated by pinning service that will receive the pin data; see Provider Hints in the docs
Origins
array
Optional list of multiaddrs known to provide the data; see Provider Hints in the docs
Pin
object
Pin object
4 properties 1 required
Status
string
Status a pin object can have at a pinning service

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-pins-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