{ "openapi": "3.0.0", "info": { "title": "IPFS RPC API", "version": "v0", "description": "When a Kubo IPFS node is running as a daemon, it exposes an HTTP RPC API that allows you to control the node and run the same commands you can from the command line.\n\nIn many cases, using this RPC API is preferable to embedding IPFS directly in your program — it allows you to maintain peer connections that are longer lived than your app and you can keep a single IPFS node running instead of several if your app can be launched multiple times. In fact, the `ipfs` CLI commands use this RPC API when operating in online mode.", "x-providerName": "IPFS", "x-logo": { "url": "https://raw.githubusercontent.com/ipfs/ipfs-docs/55fe8bc6a53ba3b9023951fb4b432efbbc81fba5/docs/.vuepress/public/images/ipfs-logo.svg" } }, "servers": [ { "description": "Local IPFS node", "url": "http://localhost:5001" }, { "description": "Local IPFS node", "url": "http://127.0.0.1:5001" }, { "description": "Infura hosted IPFS node", "url": "https://ipfs.infura.io:5001" } ], "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/" }, "paths": { "/api/v0/add": { "post": { "operationId": "add", "description": "Add a file or directory to IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-add" }, "parameters": [ { "name": "quiet", "in": "query", "description": "Write minimal output.", "schema": { "type": "boolean" } }, { "name": "quieter", "in": "query", "description": "Write only final hash.", "schema": { "type": "boolean" } }, { "name": "silent", "in": "query", "description": "Write no output.", "schema": { "type": "boolean" } }, { "name": "progress", "in": "query", "description": "Stream progress data.", "schema": { "type": "boolean" } }, { "name": "trickle", "in": "query", "description": "Use trickle-dag format for dag generation.", "schema": { "type": "boolean" } }, { "name": "only-hash", "in": "query", "description": "Only chunk and hash - do not write to disk.", "schema": { "type": "boolean" } }, { "name": "wrap-with-directory", "in": "query", "description": "Wrap files with a directory object.", "schema": { "type": "boolean" } }, { "name": "chunker", "in": "query", "description": "Chunking algorithm, size-[bytes], rabin-[min]-[avg]-[max] or buzhash.", "schema": { "type": "string", "default": "size-262144" } }, { "name": "raw-leaves", "in": "query", "description": "Use raw blocks for leaf nodes.", "schema": { "type": "boolean" } }, { "name": "nocopy", "in": "query", "description": "Add the file using filestore. Implies raw-leaves. (experimental).", "x-experimental": true, "schema": { "type": "boolean" } }, { "name": "fscache", "in": "query", "description": "Check the filestore for pre-existing blocks. (experimental).", "x-experimental": true, "schema": { "type": "boolean" } }, { "name": "cid-version", "in": "query", "description": "CID version. Defaults to 0 unless an option that depends on CIDv1 is passed. Passing version 1 will cause the raw-leaves option to default to true.", "schema": { "type": "integer" } }, { "name": "hash", "in": "query", "description": "Hash function to use. Implies CIDv1 if not sha2-256. (experimental).", "x-experimental": true, "schema": { "type": "string", "default": "sha2-256" } }, { "name": "inline", "in": "query", "description": "Inline small blocks into CIDs. (experimental).", "x-experimental": true, "schema": { "type": "boolean" } }, { "name": "inline-limit", "in": "query", "description": "Maximum block size to inline. (experimental).", "x-experimental": true, "schema": { "type": "integer", "default": 32 } }, { "name": "pin", "in": "query", "description": "Pin locally to protect added files from garbage collection.", "schema": { "type": "boolean", "default": true } }, { "name": "to-files", "in": "query", "description": "Add reference to Files API (MFS) at the provided path.", "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `path` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.\n\n\n\nThe `add` command not only allows adding files, but also uploading directories and complex hierarchies.\n\nThis happens as follows: Every part in the multipart request is a *directory* or a *file* to be added to IPFS.\n\nDirectory parts have a special content type `application/x-directory`. These parts do not carry any data. The part headers look as follows:\n\n```\nContent-Disposition: form-data; name=\"file\"; filename=\"folderName\"\nContent-Type: application/x-directory\n```\n\nFile parts carry the file payload after the following headers:\n\n```\nAbspath: /absolute/path/to/file.txt\nContent-Disposition: form-data; name=\"file\"; filename=\"folderName%2Ffile.txt\"\nContent-Type: application/octet-stream\n\n...contents...\n```\n\nThe above file includes its path in the \"folderName/file.txt\" hierarchy and IPFS will therefore be able to add it inside \"folderName\". The parts declaring the directories are optional when they have files inside and will be inferred from the filenames. In any case, a depth-first traversal of the directory tree is recommended to order the different parts making the request.\n\nThe `Abspath` header is included for filestore/urlstore features that are enabled with the `nocopy` option and it can be set to the location of the file in the filesystem (within the IPFS root), or to its full web URL.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Bytes": "", "Hash": "", "Name": "", "Size": "" } } } } } } }, "/api/v0/bitswap/ledger": { "post": { "operationId": "bitswap/ledger", "description": "Show the current ledger for a peer.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bitswap-ledger" }, "parameters": [ { "name": "arg", "in": "query", "description": "The PeerID (B58) of the ledger to inspect.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Exchanged": "", "Peer": "", "Recv": "", "Sent": "", "Value": "" } } } } } } }, "/api/v0/bitswap/reprovide": { "post": { "operationId": "bitswap/reprovide", "description": "Trigger reprovider.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bitswap-reprovide" }, "parameters": [], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/bitswap/stat": { "post": { "operationId": "bitswap/stat", "description": "Show some diagnostic information on the bitswap agent.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bitswap-stat" }, "parameters": [ { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "human", "in": "query", "description": "Print sizes in human readable format (e.g., 1K 234M 2G).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "BlocksReceived": "", "BlocksSent": "", "DataReceived": "", "DataSent": "", "DupBlksReceived": "", "DupDataReceived": "", "MessagesReceived": "", "Peers": [ "" ], "ProvideBufLen": "", "Wantlist": [ { "/": "" } ] } } } } } } }, "/api/v0/bitswap/wantlist": { "post": { "operationId": "bitswap/wantlist", "description": "Show blocks currently on the wantlist.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bitswap-wantlist" }, "parameters": [ { "name": "peer", "in": "query", "description": "Specify which peer to show wantlist for.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Keys": [ { "/": "" } ] } } } } } } }, "/api/v0/block/get": { "post": { "operationId": "block/get", "description": "Get a raw IPFS block.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-block-get" }, "parameters": [ { "name": "arg", "in": "query", "description": "The CID of an existing block to get.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/block/put": { "post": { "operationId": "block/put", "description": "Store input as an IPFS block.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-block-put" }, "parameters": [ { "name": "cid-codec", "in": "query", "description": "Multicodec to use in returned CID.", "schema": { "type": "string", "default": "raw" } }, { "name": "mhtype", "in": "query", "description": "Multihash hash function.", "schema": { "type": "string", "default": "sha2-256" } }, { "name": "mhlen", "in": "query", "description": "Multihash hash length.", "schema": { "type": "integer", "default": -1 } }, { "name": "pin", "in": "query", "description": "Pin added blocks recursively.", "schema": { "type": "boolean", "default": false } }, { "name": "allow-big-block", "in": "query", "description": "Disable block size check and allow creation of blocks bigger than 1MiB. WARNING: such blocks won't be transferable over the standard bitswap.", "schema": { "type": "boolean", "default": false } }, { "name": "format", "in": "query", "description": "Use legacy format for returned CID (DEPRECATED).", "deprecated": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Key": "", "Size": "" } } } } } } }, "/api/v0/block/rm": { "post": { "operationId": "block/rm", "description": "Remove IPFS block(s) from the local datastore.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-block-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "CIDs of block(s) to remove.", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "Ignore nonexistent blocks.", "schema": { "type": "boolean" } }, { "name": "quiet", "in": "query", "description": "Write minimal output.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Error": "", "Hash": "" } } } } } } }, "/api/v0/block/stat": { "post": { "operationId": "block/stat", "description": "Print information of a raw IPFS block.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-block-stat" }, "parameters": [ { "name": "arg", "in": "query", "description": "The CID of an existing block to stat.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Key": "", "Size": "" } } } } } } }, "/api/v0/bootstrap": { "post": { "operationId": "bootstrap", "description": "Show or edit the list of bootstrap peers.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/bootstrap/add": { "post": { "operationId": "bootstrap/add", "description": "Add peers to the bootstrap list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "A peer to add to the bootstrap list (in the format '/')", "schema": { "type": "string" } }, { "name": "default", "in": "query", "description": "Add default bootstrap nodes. (Deprecated, use 'default' subcommand instead).", "deprecated": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/bootstrap/add/default": { "post": { "operationId": "bootstrap/add/default", "description": "Add default peers to the bootstrap list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-add-default" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/bootstrap/list": { "post": { "operationId": "bootstrap/list", "description": "Show peers in the bootstrap list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-list" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/bootstrap/rm": { "post": { "operationId": "bootstrap/rm", "description": "Remove peers from the bootstrap list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "A peer to add to the bootstrap list (in the format '/')", "schema": { "type": "string" } }, { "name": "all", "in": "query", "description": "Remove all bootstrap peers. (Deprecated, use 'all' subcommand).", "deprecated": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/bootstrap/rm/all": { "post": { "operationId": "bootstrap/rm/all", "description": "Remove all peers from the bootstrap list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-rm-all" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ "" ] } } } } } } }, "/api/v0/cat": { "post": { "operationId": "cat", "description": "Show IPFS object data.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cat" }, "parameters": [ { "name": "arg", "in": "query", "description": "The path to the IPFS object(s) to be outputted.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Byte offset to begin reading from.", "schema": { "type": "integer" } }, { "name": "length", "in": "query", "description": "Maximum number of bytes to read.", "schema": { "type": "integer" } }, { "name": "progress", "in": "query", "description": "Stream progress data.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/cid/base32": { "post": { "operationId": "cid/base32", "description": "Convert CIDs to Base32 CID version 1.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cid-base32" }, "parameters": [ { "name": "arg", "in": "query", "description": "CIDs to convert.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "CidStr": "", "ErrorMsg": "", "Formatted": "" } } } } } } }, "/api/v0/cid/bases": { "post": { "operationId": "cid/bases", "description": "List available multibase encodings.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cid-bases" }, "parameters": [ { "name": "prefix", "in": "query", "description": "also include the single letter prefixes in addition to the code.", "schema": { "type": "boolean" } }, { "name": "numeric", "in": "query", "description": "also include numeric codes.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": [ { "Code": "", "Name": "" } ] } } } } } }, "/api/v0/cid/codecs": { "post": { "operationId": "cid/codecs", "description": "List available CID multicodecs.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cid-codecs" }, "parameters": [ { "name": "numeric", "in": "query", "description": "also include numeric codes.", "schema": { "type": "boolean" } }, { "name": "supported", "in": "query", "description": "list only codecs supported by go-ipfs commands.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": [ { "Code": "", "Name": "" } ] } } } } } }, "/api/v0/cid/format": { "post": { "operationId": "cid/format", "description": "Format and convert a CID in various useful ways.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cid-format" }, "parameters": [ { "name": "arg", "in": "query", "description": "CIDs to format.", "required": true, "schema": { "type": "string" } }, { "name": "f", "in": "query", "description": "Printf style format string.", "schema": { "type": "string", "default": "%s" } }, { "name": "v", "in": "query", "description": "CID version to convert to.", "schema": { "type": "string" } }, { "name": "mc", "in": "query", "description": "CID multicodec to convert to.", "schema": { "type": "string" } }, { "name": "b", "in": "query", "description": "Multibase to display CID in.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "CidStr": "", "ErrorMsg": "", "Formatted": "" } } } } } } }, "/api/v0/cid/hashes": { "post": { "operationId": "cid/hashes", "description": "List available multihashes.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cid-hashes" }, "parameters": [ { "name": "numeric", "in": "query", "description": "also include numeric codes.", "schema": { "type": "boolean" } }, { "name": "supported", "in": "query", "description": "list only codecs supported by go-ipfs commands.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": [ { "Code": "", "Name": "" } ] } } } } } }, "/api/v0/commands": { "post": { "operationId": "commands", "description": "List all available commands.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-commands" }, "parameters": [ { "name": "flags", "in": "query", "description": "Show command flags.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Name": "", "Options": [ { "Names": [ "" ] } ], "Subcommands": [ { "Name": "", "Options": [ { "Names": [ "" ] } ], "Subcommands": [ "..." ] } ] } } } } } } }, "/api/v0/config": { "post": { "operationId": "config", "description": "Get and set IPFS config values.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-config" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: The key of the config entry (e.g. \"Addresses.API\").\n\narg1: The value to set the config entry to.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "bool", "in": "query", "description": "Set a boolean value.", "schema": { "type": "boolean" } }, { "name": "json", "in": "query", "description": "Parse stringified JSON.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Key": "", "Value": "" } } } } } } }, "/api/v0/config/profile/apply": { "post": { "operationId": "config/profile/apply", "description": "Apply profile to config.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-config-profile-apply" }, "parameters": [ { "name": "arg", "in": "query", "description": "The profile to apply to the config.", "required": true, "schema": { "type": "string" } }, { "name": "dry-run", "in": "query", "description": "print difference between the current config and the config that would be generated.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "NewCfg": { "": "" }, "OldCfg": { "": "" } } } } } } } }, "/api/v0/config/replace": { "post": { "operationId": "config/replace", "description": "Replace the config with <file>.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-config-replace" }, "parameters": [], "requestBody": { "description": "Argument `file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/config/show": { "post": { "operationId": "config/show", "description": "Output config file contents.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-config-show" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "": "" } } } } } } }, "/api/v0/dag/export": { "post": { "operationId": "dag/export", "description": "Streams the selected DAG as a .car stream on stdout.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-export" }, "parameters": [ { "name": "arg", "in": "query", "description": "CID of a root to recursively export", "required": true, "schema": { "type": "string" } }, { "name": "progress", "in": "query", "description": "Display progress on CLI. Defaults to true when STDERR is a TTY.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/dag/get": { "post": { "operationId": "dag/get", "description": "Get a DAG node from IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-get" }, "parameters": [ { "name": "arg", "in": "query", "description": "The object to get", "required": true, "schema": { "type": "string" } }, { "name": "output-codec", "in": "query", "description": "Format that the object will be encoded as.", "schema": { "type": "string", "default": "dag-json" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/dag/import": { "post": { "operationId": "dag/import", "description": "Import the contents of .car files", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-import" }, "parameters": [ { "name": "pin-roots", "in": "query", "description": "Pin optional roots listed in the .car headers after importing.", "schema": { "type": "boolean", "default": true } }, { "name": "silent", "in": "query", "description": "No output.", "schema": { "type": "boolean" } }, { "name": "stats", "in": "query", "description": "Output stats.", "schema": { "type": "boolean" } }, { "name": "allow-big-block", "in": "query", "description": "Disable block size check and allow creation of blocks bigger than 1MiB. WARNING: such blocks won't be transferable over the standard bitswap.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Argument `path` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Root": { "Cid": { "/": "" }, "PinErrorMsg": "" }, "Stats": { "BlockBytesCount": "", "BlockCount": "" } } } } } } } }, "/api/v0/dag/put": { "post": { "operationId": "dag/put", "description": "Add a DAG node to IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-put" }, "parameters": [ { "name": "store-codec", "in": "query", "description": "Codec that the stored object will be encoded with.", "schema": { "type": "string", "default": "dag-cbor" } }, { "name": "input-codec", "in": "query", "description": "Codec that the input object is encoded in.", "schema": { "type": "string", "default": "dag-json" } }, { "name": "pin", "in": "query", "description": "Pin this object when adding.", "schema": { "type": "boolean" } }, { "name": "hash", "in": "query", "description": "Hash function to use.", "schema": { "type": "string", "default": "sha2-256" } }, { "name": "allow-big-block", "in": "query", "description": "Disable block size check and allow creation of blocks bigger than 1MiB. WARNING: such blocks won't be transferable over the standard bitswap.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Argument `object data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": { "/": "" } } } } } } } }, "/api/v0/dag/resolve": { "post": { "operationId": "dag/resolve", "description": "Resolve IPLD block.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-resolve" }, "parameters": [ { "name": "arg", "in": "query", "description": "The path to resolve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": { "/": "" }, "RemPath": "" } } } } } } }, "/api/v0/dag/stat": { "post": { "operationId": "dag/stat", "description": "Gets stats for a DAG.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dag-stat" }, "parameters": [ { "name": "arg", "in": "query", "description": "CID of a DAG root to get statistics for", "required": true, "schema": { "type": "string" } }, { "name": "progress", "in": "query", "description": "Return progressive data while reading through the DAG.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "NumBlocks": "", "Size": "" } } } } } } }, "/api/v0/dht/query": { "post": { "operationId": "dht/query", "description": "Find the closest Peer IDs to a given Peer ID by querying the DHT.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-query" }, "parameters": [ { "name": "arg", "in": "query", "description": "The peerID to run the query against.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/diag/cmds": { "post": { "operationId": "diag/cmds", "description": "List commands run on this IPFS node.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-diag-cmds" }, "parameters": [ { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": [ { "Active": "", "Args": [ "" ], "Command": "", "EndTime": "", "ID": "", "Options": { "": "" }, "StartTime": "" } ] } } } } } }, "/api/v0/diag/cmds/clear": { "post": { "operationId": "diag/cmds/clear", "description": "Clear inactive requests from the log.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-diag-cmds-clear" }, "parameters": [], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/diag/cmds/set-time": { "post": { "operationId": "diag/cmds/set-time", "description": "Set how long to keep inactive requests in the log.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-diag-cmds-set-time" }, "parameters": [ { "name": "arg", "in": "query", "description": "Time to keep inactive requests in log.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/diag/profile": { "post": { "operationId": "diag/profile", "description": "Collect a performance profile for debugging.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-diag-profile" }, "parameters": [ { "name": "output", "in": "query", "description": "The path where the output .zip should be stored.", "schema": { "type": "string", "default": "./ipfs-profile-[timestamp].zip" } }, { "name": "collectors", "in": "query", "description": "The list of collectors to use for collecting diagnostic data.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "profile-time", "in": "query", "description": "The amount of time spent profiling. If this is set to 0, then sampling profiles are skipped.", "schema": { "type": "string", "default": "30s" } }, { "name": "mutex-profile-fraction", "in": "query", "description": "The fraction 1/n of mutex contention events that are reported in the mutex profile.", "schema": { "type": "integer", "default": 4 } }, { "name": "block-profile-rate", "in": "query", "description": "The duration to wait between sampling goroutine-blocking events for the blocking profile.", "schema": { "type": "string", "default": "1ms" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/diag/sys": { "post": { "operationId": "diag/sys", "description": "Print system diagnostic information.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-diag-sys" }, "parameters": [], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/chcid": { "post": { "operationId": "files/chcid", "description": "Change the CID version or hash function of the root node of a given path.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-chcid" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to change.", "schema": { "type": "string", "default": "'/'" } }, { "name": "cid-version", "in": "query", "description": "Cid version to use. (experimental).", "x-experimental": true, "schema": { "type": "integer" } }, { "name": "hash", "in": "query", "description": "Hash function to use. Will set Cid version to 1 if used. (experimental).", "x-experimental": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/cp": { "post": { "operationId": "files/cp", "description": "Add references to IPFS files and directories in MFS (or copy within MFS).", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-cp" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Source IPFS or MFS path to copy.\n\narg1: Destination within MFS.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "parents", "in": "query", "description": "Make parent directories as needed.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/flush": { "post": { "operationId": "files/flush", "description": "Flush a given path's data to disk.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-flush" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to flush.", "schema": { "type": "string", "default": "'/'" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": "" } } } } } } }, "/api/v0/files/ls": { "post": { "operationId": "files/ls", "description": "List directories in the local mutable namespace.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-ls" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to show listing for. Defaults to '/'.", "schema": { "type": "string" } }, { "name": "long", "in": "query", "description": "Use long listing format.", "schema": { "type": "boolean" } }, { "name": "U", "in": "query", "description": "Do not sort; list entries in directory order.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Entries": [ { "Hash": "", "Name": "", "Size": "", "Type": "" } ] } } } } } } }, "/api/v0/files/mkdir": { "post": { "operationId": "files/mkdir", "description": "Make directories.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-mkdir" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to dir to make.", "required": true, "schema": { "type": "string" } }, { "name": "parents", "in": "query", "description": "No error if existing, make parent directories as needed.", "schema": { "type": "boolean" } }, { "name": "cid-version", "in": "query", "description": "Cid version to use. (experimental).", "x-experimental": true, "schema": { "type": "integer" } }, { "name": "hash", "in": "query", "description": "Hash function to use. Will set Cid version to 1 if used. (experimental).", "x-experimental": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/mv": { "post": { "operationId": "files/mv", "description": "Move files.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-mv" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Source file to move.\n\narg1: Destination path for file to be moved to.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/read": { "post": { "operationId": "files/read", "description": "Read a file from MFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-read" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to file to be read.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Byte offset to begin reading from.", "schema": { "type": "integer" } }, { "name": "count", "in": "query", "description": "Maximum number of bytes to read.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/rm": { "post": { "operationId": "files/rm", "description": "Remove a file from MFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "File to remove.", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Recursively remove directories.", "schema": { "type": "boolean" } }, { "name": "force", "in": "query", "description": "Forcibly remove target at path; implies -r for directories.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/files/stat": { "post": { "operationId": "files/stat", "description": "Display file status.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-stat" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to node to stat.", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Print statistics in given format. Allowed tokens: . Conflicts with other format options.", "schema": { "type": "string", "default": "\nSize: \nCumulativeSize: \nChildBlocks: \nType: " } }, { "name": "hash", "in": "query", "description": "Print only hash. Implies '--format='. Conflicts with other format options.", "schema": { "type": "boolean" } }, { "name": "size", "in": "query", "description": "Print only size. Implies '--format='. Conflicts with other format options.", "schema": { "type": "boolean" } }, { "name": "with-local", "in": "query", "description": "Compute the amount of the dag that is local, and if possible the total size.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Blocks": "", "CumulativeSize": "", "Hash": "", "Local": "", "Size": "", "SizeLocal": "", "Type": "", "WithLocality": "" } } } } } } }, "/api/v0/files/write": { "post": { "operationId": "files/write", "description": "Append to (modify) a file in MFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-files-write" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to write to.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Byte offset to begin writing at.", "schema": { "type": "integer" } }, { "name": "create", "in": "query", "description": "Create the file if it does not exist.", "schema": { "type": "boolean" } }, { "name": "parents", "in": "query", "description": "Make parent directories as needed.", "schema": { "type": "boolean" } }, { "name": "truncate", "in": "query", "description": "Truncate the file to size zero before writing.", "schema": { "type": "boolean" } }, { "name": "count", "in": "query", "description": "Maximum number of bytes to read.", "schema": { "type": "integer" } }, { "name": "raw-leaves", "in": "query", "description": "Use raw blocks for newly created leaf nodes. (experimental).", "x-experimental": true, "schema": { "type": "boolean" } }, { "name": "cid-version", "in": "query", "description": "Cid version to use. (experimental).", "x-experimental": true, "schema": { "type": "integer" } }, { "name": "hash", "in": "query", "description": "Hash function to use. Will set Cid version to 1 if used. (experimental).", "x-experimental": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/filestore/dups": { "post": { "operationId": "filestore/dups", "description": "List blocks that are both in the filestore and standard block storage.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-dups" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Err": "", "Ref": "" } } } } } } }, "/api/v0/filestore/ls": { "post": { "operationId": "filestore/ls", "description": "List objects in filestore.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-ls" }, "parameters": [ { "name": "arg", "in": "query", "description": "Cid of objects to list.", "schema": { "type": "string" } }, { "name": "file-order", "in": "query", "description": "sort the results based on the path of the backing file.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "ErrorMsg": "", "FilePath": "", "Key": { "/": "" }, "Offset": "", "Size": "", "Status": "" } } } } } } }, "/api/v0/filestore/verify": { "post": { "operationId": "filestore/verify", "description": "Verify objects in filestore.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-verify" }, "parameters": [ { "name": "arg", "in": "query", "description": "Cid of objects to verify.", "schema": { "type": "string" } }, { "name": "file-order", "in": "query", "description": "verify the objects based on the order of the backing file.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "ErrorMsg": "", "FilePath": "", "Key": { "/": "" }, "Offset": "", "Size": "", "Status": "" } } } } } } }, "/api/v0/get": { "post": { "operationId": "get", "description": "Download IPFS objects.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-get" }, "parameters": [ { "name": "arg", "in": "query", "description": "The path to the IPFS object(s) to be outputted.", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "description": "The path where the output should be stored.", "schema": { "type": "string" } }, { "name": "archive", "in": "query", "description": "Output a TAR archive.", "schema": { "type": "boolean" } }, { "name": "compress", "in": "query", "description": "Compress the output with GZIP compression.", "schema": { "type": "boolean" } }, { "name": "compression-level", "in": "query", "description": "The level of compression (1-9).", "schema": { "type": "integer" } }, { "name": "progress", "in": "query", "description": "Stream progress data.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/id": { "post": { "operationId": "id", "description": "Show IPFS node id info.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-id" }, "parameters": [ { "name": "arg", "in": "query", "description": "Peer.ID of node to look up.", "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Optional output format.", "schema": { "type": "string" } }, { "name": "peerid-base", "in": "query", "description": "Encoding used for peer IDs: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "b58mh" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Addresses": [ "" ], "AgentVersion": "", "ID": "", "ProtocolVersion": "", "Protocols": [ "" ], "PublicKey": "" } } } } } } }, "/api/v0/key/gen": { "post": { "operationId": "key/gen", "description": "Create a new keypair", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-key-gen" }, "parameters": [ { "name": "arg", "in": "query", "description": "name of key to create", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "type of the key to create: rsa, ed25519.", "schema": { "type": "string", "default": "ed25519" } }, { "name": "size", "in": "query", "description": "size of the key to generate.", "schema": { "type": "integer" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Id": "", "Name": "" } } } } } } }, "/api/v0/key/import": { "post": { "operationId": "key/import", "description": "Import a key and prints imported key id", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-key-import" }, "parameters": [ { "name": "arg", "in": "query", "description": "name to associate with key in keychain", "required": true, "schema": { "type": "string" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } }, { "name": "format", "in": "query", "description": "The format of the private key to import, libp2p-protobuf-cleartext or pem-pkcs8-cleartext.", "schema": { "type": "string", "default": "libp2p-protobuf-cleartext" } }, { "name": "allow-any-key-type", "in": "query", "description": "Allow importing any key type.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Argument `key` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Id": "", "Name": "" } } } } } } }, "/api/v0/key/list": { "post": { "operationId": "key/list", "description": "List all local keypairs.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-key-list" }, "parameters": [ { "name": "l", "in": "query", "description": "Show extra information about keys.", "schema": { "type": "boolean" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Keys": [ { "Id": "", "Name": "" } ] } } } } } } }, "/api/v0/key/rename": { "post": { "operationId": "key/rename", "description": "Rename a keypair.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-key-rename" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: name of key to rename\n\narg1: new name of the key", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "force", "in": "query", "description": "Allow to overwrite an existing key.", "schema": { "type": "boolean" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Id": "", "Now": "", "Overwrite": "", "Was": "" } } } } } } }, "/api/v0/key/rm": { "post": { "operationId": "key/rm", "description": "Remove a keypair.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-key-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "names of keys to remove", "required": true, "schema": { "type": "string" } }, { "name": "l", "in": "query", "description": "Show extra information about keys.", "schema": { "type": "boolean" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Keys": [ { "Id": "", "Name": "" } ] } } } } } } }, "/api/v0/log/level": { "post": { "operationId": "log/level", "description": "Change the logging level.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-log-level" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: The subsystem logging identifier. Use 'all' for all subsystems.\n\narg1: The log level, with 'debug' the most verbose and 'fatal' the least verbose.\nOne of: debug, info, warn, error, dpanic, panic, fatal.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Message": "" } } } } } } }, "/api/v0/log/ls": { "post": { "operationId": "log/ls", "description": "List the logging subsystems.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-log-ls" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/ls": { "post": { "operationId": "ls", "description": "List directory contents for Unix filesystem objects.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-ls" }, "parameters": [ { "name": "arg", "in": "query", "description": "The path to the IPFS object(s) to list links from.", "required": true, "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Print table headers (Hash, Size, Name).", "schema": { "type": "boolean" } }, { "name": "resolve-type", "in": "query", "description": "Resolve linked objects to find out their types.", "schema": { "type": "boolean", "default": true } }, { "name": "size", "in": "query", "description": "Resolve linked objects to find out their file size.", "schema": { "type": "boolean", "default": true } }, { "name": "stream", "in": "query", "description": "Enable experimental streaming of directory entries as they are traversed.", "x-experimental": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Objects": [ { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "", "Target": "", "Type": "" } ] } ] } } } } } } }, "/api/v0/multibase/decode": { "post": { "operationId": "multibase/decode", "description": "Decode multibase string", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-multibase-decode" }, "parameters": [], "requestBody": { "description": "Argument `encoded_file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/multibase/encode": { "post": { "operationId": "multibase/encode", "description": "Encode data into multibase string", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-multibase-encode" }, "parameters": [ { "name": "b", "in": "query", "description": "multibase encoding.", "schema": { "type": "string", "default": "base64url" } } ], "requestBody": { "description": "Argument `file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/multibase/list": { "post": { "operationId": "multibase/list", "description": "List available multibase encodings.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-multibase-list" }, "parameters": [ { "name": "prefix", "in": "query", "description": "also include the single letter prefixes in addition to the code.", "schema": { "type": "boolean" } }, { "name": "numeric", "in": "query", "description": "also include numeric codes.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": [ { "Code": "", "Name": "" } ] } } } } } }, "/api/v0/multibase/transcode": { "post": { "operationId": "multibase/transcode", "description": "Transcode multibase string between bases", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-multibase-transcode" }, "parameters": [ { "name": "b", "in": "query", "description": "multibase encoding.", "schema": { "type": "string", "default": "base64url" } } ], "requestBody": { "description": "Argument `encoded_file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/name/publish": { "post": { "operationId": "name/publish", "description": "Publish IPNS names.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-publish" }, "parameters": [ { "name": "arg", "in": "query", "description": "ipfs path of the object to be published.", "required": true, "schema": { "type": "string" } }, { "name": "resolve", "in": "query", "description": "Check if the given path can be resolved before publishing.", "schema": { "type": "boolean", "default": true } }, { "name": "lifetime", "in": "query", "description": "Time duration that the record will be valid for.\nThis accepts durations such as \"300s\", \"1.5h\" or \"2h45m\". Valid time units are\n\"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".", "schema": { "type": "string", "default": "24h" } }, { "name": "allow-offline", "in": "query", "description": "When offline, save the IPNS record to the the local datastore without broadcasting to the network instead of simply failing.", "schema": { "type": "boolean" } }, { "name": "ttl", "in": "query", "description": "Time duration this record should be cached for. Uses the same syntax as the lifetime option. (caution: experimental).", "x-experimental": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Name of the key to be used or a valid PeerID, as listed by 'ipfs key list -l'.", "schema": { "type": "string", "default": "self" } }, { "name": "quieter", "in": "query", "description": "Write only final hash.", "schema": { "type": "boolean" } }, { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Name": "", "Value": "" } } } } } } }, "/api/v0/name/resolve": { "post": { "operationId": "name/resolve", "description": "Resolve IPNS names.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-resolve" }, "parameters": [ { "name": "arg", "in": "query", "description": "The IPNS name to resolve. Defaults to your node's peerID.", "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Resolve until the result is not an IPNS name.", "schema": { "type": "boolean", "default": true } }, { "name": "nocache", "in": "query", "description": "Do not use cached entries.", "schema": { "type": "boolean" } }, { "name": "dht-record-count", "in": "query", "description": "Number of records to request for DHT resolution.", "schema": { "type": "integer" } }, { "name": "dht-timeout", "in": "query", "description": "Max time to collect values during DHT resolution eg \"30s\". Pass 0 for no timeout.", "schema": { "type": "string" } }, { "name": "stream", "in": "query", "description": "Stream entries as they are found.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Path": "" } } } } } } }, "/api/v0/pin/add": { "post": { "operationId": "pin/add", "description": "Pin objects to local storage.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to object(s) to be pinned.", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Recursively pin the object linked to by the specified object(s).", "schema": { "type": "boolean", "default": true } }, { "name": "progress", "in": "query", "description": "Show progress.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Pins": [ "" ], "Progress": "" } } } } } } }, "/api/v0/pin/ls": { "post": { "operationId": "pin/ls", "description": "List objects pinned to local storage.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-ls" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to object(s) to be listed.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The type of pinned keys to list. Can be \"direct\", \"indirect\", \"recursive\", or \"all\".", "schema": { "type": "string", "default": "all" } }, { "name": "quiet", "in": "query", "description": "Write just hashes of objects.", "schema": { "type": "boolean" } }, { "name": "stream", "in": "query", "description": "Enable streaming of pins as they are discovered.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "PinLsList": { "Keys": { "": { "Type": "" } } }, "PinLsObject": { "Cid": "", "Type": "" } } } } } } } }, "/api/v0/pin/remote/add": { "post": { "operationId": "pin/remote/add", "description": "Pin object to remote pinning service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "CID or Path to be pinned.", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Name of the remote pinning service to use (mandatory).", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "An optional name for the pin.", "schema": { "type": "string" } }, { "name": "background", "in": "query", "description": "Add to the queue on the remote service and return immediately (does not wait for pinned status).", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": "", "Name": "", "Status": "" } } } } } } }, "/api/v0/pin/remote/ls": { "post": { "operationId": "pin/remote/ls", "description": "List objects pinned to remote pinning service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-ls" }, "parameters": [ { "name": "service", "in": "query", "description": "Name of the remote pinning service to use (mandatory).", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Return pins with names that contain the value provided (case-sensitive, exact match).", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "description": "Return pins for the specified CIDs (comma-separated).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Return pins with the specified statuses (queued,pinning,pinned,failed).", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": "", "Name": "", "Status": "" } } } } } } }, "/api/v0/pin/remote/rm": { "post": { "operationId": "pin/remote/rm", "description": "Remove pins from remote pinning service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-rm" }, "parameters": [ { "name": "service", "in": "query", "description": "Name of the remote pinning service to use (mandatory).", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Remove pins with names that contain provided value (case-sensitive, exact match).", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "description": "Remove pins for the specified CIDs.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Remove pins with the specified statuses (queued,pinning,pinned,failed).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "force", "in": "query", "description": "Allow removal of multiple pins matching the query without additional confirmation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/pin/remote/service/add": { "post": { "operationId": "pin/remote/service/add", "description": "Add remote pinning service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-service-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Service name.\n\narg1: Service endpoint.\n\narg2: Service key.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/pin/remote/service/ls": { "post": { "operationId": "pin/remote/service/ls", "description": "List remote pinning services.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-service-ls" }, "parameters": [ { "name": "stat", "in": "query", "description": "Try to fetch and display current pin count on remote service (queued/pinning/pinned/failed).", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "RemoteServices": [ { "ApiEndpoint": "", "Service": "", "Stat": { "PinCount": { "Failed": "", "Pinned": "", "Pinning": "", "Queued": "" }, "Status": "" } } ] } } } } } } }, "/api/v0/pin/remote/service/rm": { "post": { "operationId": "pin/remote/service/rm", "description": "Remove remote pinning service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-remote-service-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "Name of remote pinning service to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/pin/rm": { "post": { "operationId": "pin/rm", "description": "Remove object from pin-list.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to object(s) to be unpinned.", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Recursively unpin the object linked to by the specified object(s).", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Pins": [ "" ] } } } } } } }, "/api/v0/pin/update": { "post": { "operationId": "pin/update", "description": "Update a recursive pin.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-update" }, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Path to old object.\n\narg1: Path to a new object to be pinned.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "unpin", "in": "query", "description": "Remove the old pin.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Pins": [ "" ] } } } } } } }, "/api/v0/pin/verify": { "post": { "operationId": "pin/verify", "description": "Verify that recursive pins are complete.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-verify" }, "parameters": [ { "name": "verbose", "in": "query", "description": "Also write the hashes of non-broken pins.", "schema": { "type": "boolean" } }, { "name": "quiet", "in": "query", "description": "Write just hashes of broken pins.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Cid": "", "PinStatus": { "BadNodes": [ { "Cid": "", "Err": "" } ], "Ok": "" } } } } } } } }, "/api/v0/ping": { "post": { "operationId": "ping", "description": "Send echo request packets to IPFS hosts.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-ping" }, "parameters": [ { "name": "arg", "in": "query", "description": "ID of peer to be pinged.", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "Number of ping messages to send.", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Success": "", "Text": "", "Time": "" } } } } } } }, "/api/v0/refs": { "post": { "operationId": "refs", "description": "List links (references) from an object.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-refs" }, "parameters": [ { "name": "arg", "in": "query", "description": "Path to the object(s) to list refs from.", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Emit edges with given format. Available tokens: .", "schema": { "type": "string", "default": "" } }, { "name": "edges", "in": "query", "description": "Emit edge format: <from> -> <to>.", "schema": { "type": "boolean" } }, { "name": "unique", "in": "query", "description": "Omit duplicate refs from output.", "schema": { "type": "boolean" } }, { "name": "recursive", "in": "query", "description": "Recursively list links of child nodes.", "schema": { "type": "boolean" } }, { "name": "max-depth", "in": "query", "description": "Only for recursive refs, limits fetch and listing to the given depth.", "schema": { "type": "integer", "default": -1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Err": "", "Ref": "" } } } } } } }, "/api/v0/refs/local": { "post": { "operationId": "refs/local", "description": "List all local references.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-refs-local" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Err": "", "Ref": "" } } } } } } }, "/api/v0/repo/gc": { "post": { "operationId": "repo/gc", "description": "Perform a garbage collection sweep on the repo.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-gc" }, "parameters": [ { "name": "stream-errors", "in": "query", "description": "Stream errors.", "schema": { "type": "boolean" } }, { "name": "quiet", "in": "query", "description": "Write minimal output.", "schema": { "type": "boolean" } }, { "name": "silent", "in": "query", "description": "Write no output.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Error": "", "Key": { "/": "" } } } } } } } }, "/api/v0/repo/ls": { "post": { "operationId": "repo/ls", "description": "List all local references.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-ls" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Err": "", "Ref": "" } } } } } } }, "/api/v0/repo/stat": { "post": { "operationId": "repo/stat", "description": "Get stats for the currently used repo.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-stat" }, "parameters": [ { "name": "size-only", "in": "query", "description": "Only report RepoSize and StorageMax.", "schema": { "type": "boolean" } }, { "name": "human", "in": "query", "description": "Print sizes in human readable format (e.g., 1K 234M 2G).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "NumObjects": "", "RepoPath": "", "SizeStat": { "RepoSize": "", "StorageMax": "" }, "Version": "" } } } } } } }, "/api/v0/repo/verify": { "post": { "operationId": "repo/verify", "description": "Verify all blocks in repo are not corrupted.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-verify" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Msg": "", "Progress": "" } } } } } } }, "/api/v0/repo/version": { "post": { "operationId": "repo/version", "description": "Show the repo version.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-version" }, "parameters": [ { "name": "quiet", "in": "query", "description": "Write minimal output.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Version": "" } } } } } } }, "/api/v0/resolve": { "post": { "operationId": "resolve", "description": "Resolve the value of names to IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-resolve" }, "parameters": [ { "name": "arg", "in": "query", "description": "The name to resolve.", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Resolve until the result is an IPFS name.", "schema": { "type": "boolean", "default": true } }, { "name": "dht-record-count", "in": "query", "description": "Number of records to request for DHT resolution.", "schema": { "type": "integer" } }, { "name": "dht-timeout", "in": "query", "description": "Max time to collect values during DHT resolution eg \"30s\". Pass 0 for no timeout.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Path": "" } } } } } } }, "/api/v0/routing/findpeer": { "post": { "operationId": "routing/findpeer", "description": "Find the multiaddresses associated with a Peer ID.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-routing-findpeer" }, "parameters": [ { "name": "arg", "in": "query", "description": "The ID of the peer to search for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/routing/findprovs": { "post": { "operationId": "routing/findprovs", "description": "Find peers that can provide a specific value, given a key.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-routing-findprovs" }, "parameters": [ { "name": "arg", "in": "query", "description": "The key to find providers for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "num-providers", "in": "query", "description": "The number of providers to find.", "schema": { "type": "integer", "default": 20 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/shutdown": { "post": { "operationId": "shutdown", "description": "Shut down the IPFS daemon.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-shutdown" }, "parameters": [], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/stats/bitswap": { "post": { "operationId": "stats/bitswap", "description": "Show some diagnostic information on the bitswap agent.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-stats-bitswap" }, "parameters": [ { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "human", "in": "query", "description": "Print sizes in human readable format (e.g., 1K 234M 2G).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "BlocksReceived": "", "BlocksSent": "", "DataReceived": "", "DataSent": "", "DupBlksReceived": "", "DupDataReceived": "", "MessagesReceived": "", "Peers": [ "" ], "ProvideBufLen": "", "Wantlist": [ { "/": "" } ] } } } } } } }, "/api/v0/stats/bw": { "post": { "operationId": "stats/bw", "description": "Print IPFS bandwidth information.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-stats-bw" }, "parameters": [ { "name": "peer", "in": "query", "description": "Specify a peer to print bandwidth for.", "schema": { "type": "string" } }, { "name": "proto", "in": "query", "description": "Specify a protocol to print bandwidth for.", "schema": { "type": "string" } }, { "name": "poll", "in": "query", "description": "Print bandwidth at an interval.", "schema": { "type": "boolean" } }, { "name": "interval", "in": "query", "description": "Time interval to wait between updating output, if 'poll' is true.This accepts durations such as \"300s\", \"1.5h\" or \"2h45m\". Valid time units are:\n\"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".", "schema": { "type": "string", "default": "1s" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "RateIn": "", "RateOut": "", "TotalIn": "", "TotalOut": "" } } } } } } }, "/api/v0/stats/dht": { "post": { "operationId": "stats/dht", "description": "Returns statistics about the node's DHT(s).", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-stats-dht" }, "parameters": [ { "name": "arg", "in": "query", "description": "The DHT whose table should be listed (wanserver, lanserver, wan, lan). wan and lan refer to client routing tables. When using the experimental DHT client only WAN is supported. Defaults to wan and lan.", "x-experimental": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Buckets": [ { "LastRefresh": "", "Peers": [ { "AgentVersion": "", "Connected": "", "ID": "", "LastQueriedAt": "", "LastUsefulAt": "" } ] } ], "Name": "" } } } } } } }, "/api/v0/stats/provide": { "post": { "operationId": "stats/provide", "description": "Returns statistics about the node's (re)provider system.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-stats-provide" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "AvgProvideDuration": "", "LastReprovideBatchSize": "", "LastReprovideDuration": "", "TotalProvides": "" } } } } } } }, "/api/v0/stats/repo": { "post": { "operationId": "stats/repo", "description": "Get stats for the currently used repo.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-stats-repo" }, "parameters": [ { "name": "size-only", "in": "query", "description": "Only report RepoSize and StorageMax.", "schema": { "type": "boolean" } }, { "name": "human", "in": "query", "description": "Print sizes in human readable format (e.g., 1K 234M 2G).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "NumObjects": "", "RepoPath": "", "SizeStat": { "RepoSize": "", "StorageMax": "" }, "Version": "" } } } } } } }, "/api/v0/swarm/addrs": { "post": { "operationId": "swarm/addrs", "description": "List known addresses. Useful for debugging.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-addrs" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Addrs": { "": [ "" ] } } } } } } } }, "/api/v0/swarm/addrs/listen": { "post": { "operationId": "swarm/addrs/listen", "description": "List interface listening addresses.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-addrs-listen" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/addrs/local": { "post": { "operationId": "swarm/addrs/local", "description": "List local addresses.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-addrs-local" }, "parameters": [ { "name": "id", "in": "query", "description": "Show peer ID in addresses.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/connect": { "post": { "operationId": "swarm/connect", "description": "Open connection to a given address.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-connect" }, "parameters": [ { "name": "arg", "in": "query", "description": "Address of peer to connect to.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/disconnect": { "post": { "operationId": "swarm/disconnect", "description": "Close connection to a given address.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-disconnect" }, "parameters": [ { "name": "arg", "in": "query", "description": "Address of peer to disconnect from.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/filters": { "post": { "operationId": "swarm/filters", "description": "Manipulate address filters.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-filters" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/filters/add": { "post": { "operationId": "swarm/filters/add", "description": "Add an address filter.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-filters-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "Multiaddr to filter.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/filters/rm": { "post": { "operationId": "swarm/filters/rm", "description": "Remove an address filter.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-filters-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "Multiaddr filter to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/swarm/peering/add": { "post": { "operationId": "swarm/peering/add", "description": "Add peers into the peering subsystem.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-peering-add" }, "parameters": [ { "name": "arg", "in": "query", "description": "address of peer to add into the peering subsystem", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "ID": "", "Status": "" } } } } } } }, "/api/v0/swarm/peering/ls": { "post": { "operationId": "swarm/peering/ls", "description": "List peers registered in the peering subsystem.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-peering-ls" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ { "Addrs": [ "" ], "ID": "peer-id" } ] } } } } } } }, "/api/v0/swarm/peering/rm": { "post": { "operationId": "swarm/peering/rm", "description": "Remove a peer from the peering subsystem.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-peering-rm" }, "parameters": [ { "name": "arg", "in": "query", "description": "ID of peer to remove from the peering subsystem", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "ID": "", "Status": "" } } } } } } }, "/api/v0/swarm/peers": { "post": { "operationId": "swarm/peers", "description": "List peers with open connections.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-peers" }, "parameters": [ { "name": "verbose", "in": "query", "description": "display all extra information.", "schema": { "type": "boolean" } }, { "name": "streams", "in": "query", "description": "Also list information about open streams for each peer.", "schema": { "type": "boolean" } }, { "name": "latency", "in": "query", "description": "Also list information about latency to each peer.", "schema": { "type": "boolean" } }, { "name": "direction", "in": "query", "description": "Also list information about the direction of connection.", "schema": { "type": "boolean" } }, { "name": "identify", "in": "query", "description": "Also list information about peers identify.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Peers": [ { "Addr": "", "Direction": "", "Identify": { "Addresses": [ "" ], "AgentVersion": "", "ID": "", "ProtocolVersion": "", "Protocols": [ "" ], "PublicKey": "" }, "Latency": "", "Muxer": "", "Peer": "", "Streams": [ { "Protocol": "" } ] } ] } } } } } } }, "/api/v0/version": { "post": { "operationId": "version", "description": "Show IPFS version information.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-version" }, "parameters": [ { "name": "number", "in": "query", "description": "Only show the version number.", "schema": { "type": "boolean" } }, { "name": "commit", "in": "query", "description": "Show the commit hash.", "schema": { "type": "boolean" } }, { "name": "repo", "in": "query", "description": "Show repo version.", "schema": { "type": "boolean" } }, { "name": "all", "in": "query", "description": "Show all version information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Commit": "", "Golang": "", "Repo": "", "System": "", "Version": "" } } } } } } }, "/api/v0/version/deps": { "post": { "operationId": "version/deps", "description": "Shows information about dependencies used for build.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-version-deps" }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Path": "", "ReplacedBy": "", "Sum": "", "Version": "" } } } } } } }, "/api/v0/log/tail": { "post": { "operationId": "log/tail", "description": "Read the event log.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-log-tail" }, "x-experimental": true, "parameters": [], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/mount": { "post": { "operationId": "mount", "description": "Mounts IPFS to the filesystem (read-only).", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-mount" }, "x-experimental": true, "parameters": [ { "name": "ipfs-path", "in": "query", "description": "The path where IPFS should be mounted.", "schema": { "type": "string" } }, { "name": "ipns-path", "in": "query", "description": "The path where IPNS should be mounted.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "FuseAllowOther": "", "IPFS": "", "IPNS": "" } } } } } } }, "/api/v0/name/inspect": { "post": { "operationId": "name/inspect", "description": "Inspects an IPNS Record", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-inspect" }, "x-experimental": true, "parameters": [ { "name": "verify", "in": "query", "description": "CID of the public IPNS key to validate against.", "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `record` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Entry": { "Data": "", "PublicKey": "", "Sequence": "", "SignatureV1": "", "SignatureV2": "", "TTL": "", "Validity": "", "ValidityType": "", "Value": "" }, "Validation": { "PublicKey": "", "Reason": "", "Valid": "" } } } } } } } }, "/api/v0/name/pubsub/cancel": { "post": { "operationId": "name/pubsub/cancel", "description": "Cancel a name subscription.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-pubsub-cancel" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "Name to cancel the subscription for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Canceled": "" } } } } } } }, "/api/v0/name/pubsub/state": { "post": { "operationId": "name/pubsub/state", "description": "Query the state of IPNS pubsub.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-pubsub-state" }, "x-experimental": true, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Enabled": "" } } } } } } }, "/api/v0/name/pubsub/subs": { "post": { "operationId": "name/pubsub/subs", "description": "Show current name subscriptions.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-name-pubsub-subs" }, "x-experimental": true, "parameters": [ { "name": "ipns-base", "in": "query", "description": "Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.", "schema": { "type": "string", "default": "base36" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/p2p/close": { "post": { "operationId": "p2p/close", "description": "Stop listening for new connections to forward.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-close" }, "x-experimental": true, "parameters": [ { "name": "all", "in": "query", "description": "Close all listeners.", "schema": { "type": "boolean" } }, { "name": "protocol", "in": "query", "description": "Match protocol name.", "schema": { "type": "string" } }, { "name": "listen-address", "in": "query", "description": "Match listen address.", "schema": { "type": "string" } }, { "name": "target-address", "in": "query", "description": "Match target address.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": "" } } } } } }, "/api/v0/p2p/forward": { "post": { "operationId": "p2p/forward", "description": "Forward connections to libp2p service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-forward" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Protocol name.\n\narg1: Listening endpoint.\n\narg2: Target endpoint.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "allow-custom-protocol", "in": "query", "description": "Don't require /x/ prefix.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/p2p/listen": { "post": { "operationId": "p2p/listen", "description": "Create libp2p service.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-listen" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Protocol name.\n\narg1: Target endpoint.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "allow-custom-protocol", "in": "query", "description": "Don't require /x/ prefix.", "schema": { "type": "boolean" } }, { "name": "report-peer-id", "in": "query", "description": "Send remote base58 peerid to target when a new connection is established.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/p2p/ls": { "post": { "operationId": "p2p/ls", "description": "List active p2p listeners.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-ls" }, "x-experimental": true, "parameters": [ { "name": "headers", "in": "query", "description": "Print table headers (Protocol, Listen, Target).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Listeners": [ { "ListenAddress": "", "Protocol": "", "TargetAddress": "" } ] } } } } } } }, "/api/v0/p2p/stream/close": { "post": { "operationId": "p2p/stream/close", "description": "Close active p2p stream.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-stream-close" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "Stream identifier", "schema": { "type": "string" } }, { "name": "all", "in": "query", "description": "Close all streams.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/p2p/stream/ls": { "post": { "operationId": "p2p/stream/ls", "description": "List active p2p streams.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-p2p-stream-ls" }, "x-experimental": true, "parameters": [ { "name": "headers", "in": "query", "description": "Print table headers (ID, Protocol, Local, Remote).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Streams": [ { "HandlerID": "", "OriginAddress": "", "Protocol": "", "TargetAddress": "" } ] } } } } } } }, "/api/v0/routing/get": { "post": { "operationId": "routing/get", "description": "Given a key, query the routing system for its best value.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-routing-get" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key to find a value for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/routing/provide": { "post": { "operationId": "routing/provide", "description": "Announce to the network that you are providing given values.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-routing-provide" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key[s] to send provide records for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "recursive", "in": "query", "description": "Recursively provide entire graph.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/routing/put": { "post": { "operationId": "routing/put", "description": "Write a key/value pair to the routing system.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-routing-put" }, "x-experimental": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key to store the value at.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `value-file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/swarm/resources": { "post": { "operationId": "swarm/resources", "description": "Get a summary of all resources accounted for by the libp2p Resource Manager.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-swarm-resources" }, "x-experimental": true, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": "" } } } } } }, "/api/v0/dht/findpeer": { "post": { "operationId": "dht/findpeer", "description": "Find the multiaddresses associated with a Peer ID.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-findpeer" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The ID of the peer to search for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/dht/findprovs": { "post": { "operationId": "dht/findprovs", "description": "Find peers that can provide a specific value, given a key.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-findprovs" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key to find providers for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "num-providers", "in": "query", "description": "The number of providers to find.", "schema": { "type": "integer", "default": 20 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/dht/get": { "post": { "operationId": "dht/get", "description": "Given a key, query the routing system for its best value.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-get" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key to find a value for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/dht/provide": { "post": { "operationId": "dht/provide", "description": "Announce to the network that you are providing given values.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-provide" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key[s] to send provide records for.", "required": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } }, { "name": "recursive", "in": "query", "description": "Recursively provide entire graph.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/dht/put": { "post": { "operationId": "dht/put", "description": "Write a key/value pair to the routing system.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-put" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The key to store the value at.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `value-file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Extra": "", "ID": "", "Responses": [ { "Addrs": [ "" ], "ID": "peer-id" } ], "Type": "" } } } } } } }, "/api/v0/dns": { "post": { "operationId": "dns", "description": "Resolve DNSLink records.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dns" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The domain-name name to resolve.", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "Resolve until the result is not a DNS link.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Path": "" } } } } } } }, "/api/v0/file/ls": { "post": { "operationId": "file/ls", "description": "List directory contents for Unix filesystem objects. Deprecated: Use 'ipfs ls' and 'ipfs files ls' instead.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-file-ls" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The path to the IPFS object(s) to list links from.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Arguments": { "": "" }, "Objects": { "": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "", "Type": "" } ], "Size": "", "Type": "" } } } } } } } } }, "/api/v0/object/data": { "post": { "operationId": "object/data", "description": "Deprecated way to read the raw bytes of a dag-pb object: use 'dag get' instead.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-data" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Key of the object to retrieve, in base58-encoded multihash format.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/object/diff": { "post": { "operationId": "object/diff", "description": "Display the diff between two IPFS objects.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-diff" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: Object to diff against.\n\narg1: Object to diff.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "verbose", "in": "query", "description": "Print extra information.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Changes": [ { "After": { "/": "" }, "Before": { "/": "" }, "Path": "", "Type": "" } ] } } } } } } }, "/api/v0/object/get": { "post": { "operationId": "object/get", "description": "Deprecated way to get and serialize the dag-pb node. Use 'dag get' instead", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-get" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Key of the dag-pb object to retrieve, in base58-encoded multihash format.", "required": true, "schema": { "type": "string" } }, { "name": "data-encoding", "in": "query", "description": "Encoding type of the data field, either \"text\" or \"base64\".", "schema": { "type": "string", "default": "text" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Data": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/links": { "post": { "operationId": "object/links", "description": "Deprecated way to output links in the specified dag-pb object: use 'dag get' instead.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-links" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Key of the dag-pb object to retrieve, in base58-encoded multihash format.", "required": true, "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Print table headers (Hash, Size, Name).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/new": { "post": { "operationId": "object/new", "description": "Deprecated way to create a new dag-pb object from a template.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-new" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Template to use. Optional.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/patch/add-link": { "post": { "operationId": "object/patch/add-link", "description": "Deprecated way to add a link to a given dag-pb.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-patch-add-link" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: The hash of the node to modify.\n\narg1: Name of link to create.\n\narg2: IPFS object to add link to.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "create", "in": "query", "description": "Create intermediary nodes.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/patch/append-data": { "post": { "operationId": "object/patch/append-data", "description": "Deprecated way to append data to the data segment of a DAG node.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-patch-append-data" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The hash of the node to modify.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/patch/rm-link": { "post": { "operationId": "object/patch/rm-link", "description": "Deprecated way to remove a link from dag-pb object.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-patch-rm-link" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "arg0: The hash of the node to modify.\n\narg1: Name of the link to remove.", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/patch/set-data": { "post": { "operationId": "object/patch/set-data", "description": "Deprecated way to set the data field of dag-pb object.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-patch-set-data" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "The hash of the node to modify.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/put": { "post": { "operationId": "object/put", "description": "Deprecated way to store input as a DAG object. Use 'dag put' instead.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-put" }, "deprecated": true, "parameters": [ { "name": "inputenc", "in": "query", "description": "Encoding type of input data. One of: {\"protobuf\", \"json\"}.", "schema": { "type": "string", "default": "json" } }, { "name": "datafieldenc", "in": "query", "description": "Encoding type of the data field, either \"text\" or \"base64\".", "schema": { "type": "string", "default": "text" } }, { "name": "pin", "in": "query", "description": "Pin this object when adding.", "schema": { "type": "boolean" } }, { "name": "quiet", "in": "query", "description": "Write minimal output.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Hash": "", "Links": [ { "Hash": "", "Name": "", "Size": "" } ] } } } } } } }, "/api/v0/object/stat": { "post": { "operationId": "object/stat", "description": "Deprecated way to read stats for the dag-pb node. Use 'files stat' instead.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-object-stat" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Key of the object to retrieve, in base58-encoded multihash format.", "required": true, "schema": { "type": "string" } }, { "name": "human", "in": "query", "description": "Print sizes in human readable format (e.g., 1K 234M 2G).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "BlockSize": "", "CumulativeSize": "", "DataSize": "", "Hash": "", "LinksSize": "", "NumLinks": "" } } } } } } }, "/api/v0/pubsub/ls": { "post": { "operationId": "pubsub/ls", "description": "List subscribed topics by name.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pubsub-ls" }, "deprecated": true, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/pubsub/peers": { "post": { "operationId": "pubsub/peers", "description": "List peers we are currently pubsubbing with.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pubsub-peers" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Topic to list connected peers of.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Strings": [ "" ] } } } } } } }, "/api/v0/pubsub/pub": { "post": { "operationId": "pubsub/pub", "description": "Publish data to a given pubsub topic.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pubsub-pub" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Topic to publish to (multibase encoded when sent over HTTP RPC).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Argument `data` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response" } } } }, "/api/v0/pubsub/sub": { "post": { "operationId": "pubsub/sub", "description": "Subscribe to messages on a given topic.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pubsub-sub" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "Name of topic to subscribe to (multibase encoded when sent over HTTP RPC).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "data": "", "from": "", "seqno": "", "topicIDs": [ "" ] } } } } } } }, "/api/v0/tar/add": { "post": { "operationId": "tar/add", "description": "Import a tar file into IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-tar-add" }, "deprecated": true, "parameters": [], "requestBody": { "description": "Argument `file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.", "content": {} }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "example": { "Bytes": "", "Hash": "", "Name": "", "Size": "" } } } } } } }, "/api/v0/tar/cat": { "post": { "operationId": "tar/cat", "description": "Export a tar file from IPFS.", "externalDocs": { "url": "https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-tar-cat" }, "deprecated": true, "parameters": [ { "name": "arg", "in": "query", "description": "ipfs path of archive to export.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } } } }