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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

IPFS

IPFS Swarm API

The Swarm API from IPFS — 13 operation(s) for swarm.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 13 operations across 13 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.

13 operations 13 paths 0 schemas 13 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 13

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

Swarm 13
POST
/api/v0/swarm/addrs
List known addresses. Useful for debugging.
swarm/addrs → 200
POST
/api/v0/swarm/addrs/listen
List interface listening addresses.
swarm/addrs/listen → 200
POST
/api/v0/swarm/addrs/local
List local addresses.
swarm/addrs/local 1 param → 200
POST
/api/v0/swarm/connect
Open connection to a given address.
swarm/connect 1 param → 200
POST
/api/v0/swarm/disconnect
Close connection to a given address.
swarm/disconnect 1 param → 200
POST
/api/v0/swarm/filters
Manipulate address filters.
swarm/filters → 200
POST
/api/v0/swarm/filters/add
Add an address filter.
swarm/filters/add 1 param → 200
POST
/api/v0/swarm/filters/rm
Remove an address filter.
swarm/filters/rm 1 param → 200
POST
/api/v0/swarm/peering/add
Add peers into the peering subsystem.
swarm/peering/add 1 param → 200
POST
/api/v0/swarm/peering/ls
List peers registered in the peering subsystem.
swarm/peering/ls → 200
POST
/api/v0/swarm/peering/rm
Remove a peer from the peering subsystem.
swarm/peering/rm 1 param → 200
POST
/api/v0/swarm/peers
List peers with open connections.
swarm/peers 5 params → 200
POST
/api/v0/swarm/resources
Get a summary of all resources accounted for by the libp2p Resource Manager.
swarm/resources → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-swarm-api-openapi.yml Raw ↑

Other APIs IPFS publishes across the network.

IPFS HTTP Gateway API
AE Profile APIs.io
IPFS Delegated Routing V1 HTTP API
AE Profile APIs.io
IPFS Add API
AE Profile APIs.io
IPFS Bitswap API
AE Profile APIs.io
IPFS Block API
AE Profile APIs.io
IPFS Bootstrap API
AE Profile APIs.io
IPFS Cat API
AE Profile APIs.io
IPFS Cid API
AE Profile APIs.io
IPFS Commands API
AE Profile APIs.io
IPFS Config API
AE Profile APIs.io
IPFS Dag API
AE Profile APIs.io
IPFS Dht API
AE Profile APIs.io
#Swarm
← Back to I APIs
API Details
ID
ipfs:ipfs-swarm-api
Base URL
http://localhost:5001
Docs
https://docs.ipfs.tech/reference/kubo/rpc/
Provider
IPFS
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network