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

The Object API from IPFS — 11 operation(s) for object.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Object. 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.

Object 11
POST
/api/v0/object/datadeprecated
Deprecated way to read the raw bytes of a dag-pb object: use 'dag get' instead.
object/data 1 param → 200
POST
/api/v0/object/diffdeprecated
Display the diff between two IPFS objects.
object/diff 2 params → 200
POST
/api/v0/object/getdeprecated
Deprecated way to get and serialize the dag-pb node. Use 'dag get' instead
object/get 2 params → 200
POST
/api/v0/object/linksdeprecated
Deprecated way to output links in the specified dag-pb object: use 'dag get' instead.
object/links 2 params → 200
POST
/api/v0/object/newdeprecated
Deprecated way to create a new dag-pb object from a template.
object/new 1 param → 200
POST
/api/v0/object/patch/add-linkdeprecated
Deprecated way to add a link to a given dag-pb.
object/patch/add-link 2 params → 200
POST
/api/v0/object/patch/append-datadeprecated
Deprecated way to append data to the data segment of a DAG node.
object/patch/append-data 1 param body → 200
POST
/api/v0/object/patch/rm-linkdeprecated
Deprecated way to remove a link from dag-pb object.
object/patch/rm-link 1 param → 200
POST
/api/v0/object/patch/set-datadeprecated
Deprecated way to set the data field of dag-pb object.
object/patch/set-data 1 param body → 200
POST
/api/v0/object/putdeprecated
Deprecated way to store input as a DAG object. Use 'dag put' instead.
object/put 4 params body → 200
POST
/api/v0/object/statdeprecated
Deprecated way to read stats for the dag-pb node. Use 'files stat' instead.
object/stat 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipfs-object-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
#Object
← Back to I APIs
API Details
ID
ipfs:ipfs-object-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