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

The Files API from IPFS — 10 operation(s) for files.

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

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

This API exposes 10 operations across 10 paths. It is described by OpenAPI 3.2.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.

10 operations 10 paths 0 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 10

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

Files 10
POST
/api/v0/files/chcid
Change the CID version or hash function of the root node of a given path.
files/chcid 3 params → 200
POST
/api/v0/files/cp
Add references to IPFS files and directories in MFS (or copy within MFS).
files/cp 2 params → 200
POST
/api/v0/files/flush
Flush a given path's data to disk.
files/flush 1 param → 200
POST
/api/v0/files/ls
List directories in the local mutable namespace.
files/ls 3 params → 200
POST
/api/v0/files/mkdir
Make directories.
files/mkdir 4 params → 200
POST
/api/v0/files/mv
Move files.
files/mv 1 param → 200
POST
/api/v0/files/read
Read a file from MFS.
files/read 3 params → 200
POST
/api/v0/files/rm
Remove a file from MFS.
files/rm 3 params → 200
POST
/api/v0/files/stat
Display file status.
files/stat 5 params → 200
POST
/api/v0/files/write
Append to (modify) a file in MFS.
files/write 9 params body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-files-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 Files 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.