How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, at version 1.0.0.

Requests are made against a single base URL, https://pinning-service.example.com.

5 operations 2 paths 10 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
http://localhost:5001
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

IPFS pins API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (accessToken). By default, every request must be authenticated.

  • accessToken — An opaque token is required to be sent with each request in the HTTP header: - Authorization: Bearer The access-token should be generated per device, and the u…

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.

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

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
Where this information came from

This is an independent, third-party profile of IPFS pins API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.