Documentation

Add a file or directory to ipfs.

Response example:

{
    "Name": "<string>"
    "Hash": "<string>"
    "Bytes": "<int64>"
    "Size": "<string>"
}

Show the current ledger for a peer.

Response example:

{
    "Peer": "<string>"
    "Value": "<float64>"
    "Sent": "<uint64>"
    "Recv": "<uint64>"
    "Exchanged": "<uint64>"
}

Trigger reprovider.

Show some diagnostic information on the bitswap agent.

Response example:

{
    "ProvideBufLen": "<int>"
    "Wantlist": [
        "<string>"
    ]
    "Peers": [
        "<string>"
    ]
    "BlocksReceived": "<uint64>"
    "DataReceived": "<uint64>"
    "BlocksSent": "<uint64>"
    "DataSent": "<uint64>"
    "DupBlksReceived": "<uint64>"
    "DupDataReceived": "<uint64>"
}

Remove a given block from your wantlist.

Show blocks currently on the wantlist.

Response example:

{
    "Keys": [
        "<string>"
    ]
}

Get a raw IPFS block.

Store input as an IPFS block.

Response example:

{
    "Key": "<string>"
    "Size": "<int>"
}

Remove IPFS block(s).

Response example:

{
    "Hash": "<string>"
    "Error": "<string>"
}

Print information of a raw IPFS block.

Response example:

{
    "Key": "<string>"
    "Size": "<int>"
}

Add default peers to the bootstrap list.

Response example:

{
    "Peers": [
        "<string>"
    ]
}

Show peers in the bootstrap list.

Response example:

{
    "Peers": [
        "<string>"
    ]
}

Remove all peers from the bootstrap list.

Response example:

{
    "Peers": [
        "<string>"
    ]
}

Show IPFS object data.

List all available commands.

Response example:

{
    "Name": "<string>"
    "Subcommands": [
        {
            "Name": "<string>"
            "Subcommands": [
                {
                    "Name": "<string>"
                    "Subcommands": [
                        ...
                    ]
                    "Options": [
                        ...
                    ]
                    "showOpts": "<bool>"
                }
            ]
            "Options": [
                {
                    "Names": [
                        ...
                    ]
                }
            ]
            "showOpts": "<bool>"
        }
    ]
    "Options": [
        {
            "Names": [
                "<string>"
            ]
        }
    ]
    "showOpts": "<bool>"
}

Open the config file for editing in $EDITOR.

Apply profile to config.

Replace the config with file.

Output config file contents.

Get a dag node from ipfs.

Add a dag node to ipfs.

Response example:

{
    "Cid": "<string>"
}

Resolve ipld block

Response example:

{
    "Cid": "<string>"
    "RemPath": "<string>"
}

Query the DHT for all of the multiaddresses associated with a Peer ID.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Find peers in the DHT that can provide a specific value, given a key.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Given a key, query the DHT for its best value.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Announce to the network that you are providing given values.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Write a key/value pair to the DHT.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Find the closest Peer IDs to a given Peer ID by querying the DHT.

Response example:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

Clear inactive requests from the log.

Set how long to keep inactive requests in the log.

Print system diagnostic information.

Resolve DNS links.

Response example:

{
    "Path": "<string>"
}

List directory contents for Unix filesystem objects.

Response example:

{
    "Arguments": {
        "<string>": "<string>"
    }
    "Objects": {
        "<string>": {
            "Hash": "<string>"
            "Size": "<uint64>"
            "Type": "<string>"
            "Links": [
                {
                    "Name": "<string>"
                    "Hash": "<string>"
                    "Size": "<uint64>"
                    "Type": "<string>"
                }
            ]
        }
    }
}

Change the cid version or hash function of the root node of a given path.

Copy files into mfs.

Flush a given path's data to disk.

List directories in the local mutable namespace.

Response example:

{
    "Entries": [
        {
            "Name": "<string>"
            "Type": "<int>"
            "Size": "<int64>"
            "Hash": "<string>"
        }
    ]
}

Make directories.

Move files.

Read a file in a given mfs.

Remove a file.

Display file status.

Response example:

{
    "Hash": "<string>"
    "Size": "<uint64>"
    "CumulativeSize": "<uint64>"
    "Blocks": "<int>"
    "Type": "<string>"
    "WithLocality": "<bool>"
    "Local": "<bool>"
    "SizeLocal": "<uint64>"
}

Write to a mutable file in a given filesystem.

List blocks that are both in the filestore and standard block storage.

Response example:

{
    "Ref": "<string>"
    "Err": "<string>"
}

List objects in filestore.

Response example:

{
    "Status": "<int32>"
    "ErrorMsg": "<string>"
    "Key": "<string>"
    "FilePath": "<string>"
    "Offset": "<uint64>"
    "Size": "<uint64>"
}

Verify objects in filestore.

Response example:

{
    "Status": "<int32>"
    "ErrorMsg": "<string>"
    "Key": "<string>"
    "FilePath": "<string>"
    "Offset": "<uint64>"
    "Size": "<uint64>"
}

Download IPFS objects.

Show ipfs node id info.

Response example:

{
    "ID": "<string>"
    "PublicKey": "<string>"
    "Addresses": [
        "<string>"
    ]
    "AgentVersion": "<string>"
    "ProtocolVersion": "<string>"
}

Create a new keypair

Response example:

{
    "Name": "<string>"
    "Id": "<string>"
}

List all local keypairs

Response example:

{
    "Keys": [
        {
            "Name": "<string>"
            "Id": "<string>"
        }
    ]
}

Rename a keypair

Response example:

{
    "Was": "<string>"
    "Now": "<string>"
    "Id": "<string>"
    "Overwrite": "<bool>"
}

Remove a keypair

Response example:

{
    "Keys": [
        {
            "Name": "<string>"
            "Id": "<string>"
        }
    ]
}

Change the logging level.

Response example:

{
    "Message": "<string>"
}

List the logging subsystems.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Read the event log.

List directory contents for Unix filesystem objects.

Response example:

{
    "Objects": [
        {
            "Hash": "<string>"
            "Links": [
                {
                    "Name": "<string>"
                    "Hash": "<string>"
                    "Size": "<uint64>"
                    "Type": "<int32>"
                }
            ]
        }
    ]
}

Mounts IPFS to the filesystem (read-only).

Response example:

{
    "IPFS": "<string>"
    "IPNS": "<string>"
    "FuseAllowOther": "<bool>"
}

Publish IPNS names.

Response example:

{
    "Name": "<string>"
    "Value": "<string>"
}

Cancel a name subscription

Response example:

{
    "Canceled": "<bool>"
}

Query the state of IPNS pubsub

Response example:

{
    "Enabled": "<bool>"
}

Show current name subscriptions

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Resolve IPNS names.

Response example:

{
    "Path": "<string>"
}

Output the raw bytes of an IPFS object.

Display the diff between two ipfs objects.

Response example:

{
    "Changes": [
        {
            "Type": "<int>"
            "Path": "<string>"
            "Before": "<string>"
            "After": "<string>"
        }
    ]
}

Get and serialize the DAG node named by key.

Response example:

{
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
    "Data": "<string>"
}

Output the links pointed to by the specified object.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Create a new object from an ipfs template.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Add a link to a given object.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Append data to the data segment of a dag node.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Remove a link from an object.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Set the data field of an IPFS object.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Store input as a DAG object, print its key.

Response example:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

Get stats for the DAG node named by key.

Response example:

{
    "Hash": "<string>"
    "NumLinks": "<int>"
    "BlockSize": "<int>"
    "LinksSize": "<int>"
    "DataSize": "<int>"
    "CumulativeSize": "<int>"
}

Close active p2p listener.

List active p2p listeners.

Response example:

{
    "Listeners": [
        {
            "Protocol": "<string>"
            "Address": "<string>"
        }
    ]
}

Forward p2p connections to a network multiaddr.

Close active p2p stream.

Dial to a p2p listener.

List active p2p streams.

Response example:

{
    "Streams": [
        {
            "HandlerID": "<string>"
            "Protocol": "<string>"
            "LocalPeer": "<string>"
            "LocalAddress": "<string>"
            "RemotePeer": "<string>"
            "RemoteAddress": "<string>"
        }
    ]
}

Pin objects to local storage.

Response example:

{
    "Pins": [
        "<string>"
    ]
    "Progress": "<int>"
}

List objects pinned to local storage.

Response example:

{
    "Keys": {
        "<string>": {
            "Type": "<string>"
        }
    }
}

Remove pinned objects from local storage.

Response example:

{
    "Pins": [
        "<string>"
    ]
}

Update a recursive pin

Response example:

{
    "Pins": [
        "<string>"
    ]
}

Verify that recursive pins are complete.

Response example:

{
    "Cid": "<string>"
    "PinStatus": {
        "Ok": "<bool>"
        "BadNodes": [
            {
                "Cid": "<string>"
                "Err": "<string>"
            }
        ]
    }
}

Send echo request packets to IPFS hosts.

Response example:

{
    "Success": "<bool>"
    "Time": "<int64>"
    "Text": "<string>"
}

List subscribed topics by name.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

List peers we are currently pubsubbing with.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Publish a message to a given pubsub topic.

Subscribe to messages on a given topic.

Response example:

{
    "Message": {
        "From": [
            "<uint8>"
        ]
        "Data": [
            "<uint8>"
        ]
        "Seqno": [
            "<uint8>"
        ]
        "TopicIDs": [
            "<string>"
        ]
        "XXX_unrecognized": [
            "<uint8>"
        ]
    }
}

List all local references.

Response example:

{
    "Ref": "<string>"
    "Err": "<string>"
}

Remove repo lockfiles.

Response example:

{
    "Message": "<string>"
}

Perform a garbage collection sweep on the repo.

Response example:

{
    "Key": "<string>"
    "Error": "<string>"
}

Get stats for the currently used repo.

Response example:

{
    "NumObjects": "<uint64>"
    "RepoSize": "<uint64>"
    "RepoPath": "<string>"
    "Version": "<string>"
    "StorageMax": "<uint64>"
}

Verify all blocks in repo are not corrupted.

Response example:

{
    "Msg": "<string>"
    "Progress": "<int>"
}

Show the repo version.

Response example:

{
    "Version": "<string>"
}

Resolve the value of names to IPFS.

Response example:

{
    "Path": "<string>"
}

Shut down the ipfs daemon

Show some diagnostic information on the bitswap agent.

Response example:

{
    "ProvideBufLen": "<int>"
    "Wantlist": [
        "<string>"
    ]
    "Peers": [
        "<string>"
    ]
    "BlocksReceived": "<uint64>"
    "DataReceived": "<uint64>"
    "BlocksSent": "<uint64>"
    "DataSent": "<uint64>"
    "DupBlksReceived": "<uint64>"
    "DupDataReceived": "<uint64>"
}

Print ipfs bandwidth information.

Response example:

{
    "TotalIn": "<int64>"
    "TotalOut": "<int64>"
    "RateIn": "<float64>"
    "RateOut": "<float64>"
}

Get stats for the currently used repo.

Response example:

{
    "NumObjects": "<uint64>"
    "RepoSize": "<uint64>"
    "RepoPath": "<string>"
    "Version": "<string>"
    "StorageMax": "<uint64>"
}

List interface listening addresses.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

List local addresses.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Open connection to a given address.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Close connection to a given address.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Add an address filter.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

Remove an address filter.

Response example:

{
    "Strings": [
        "<string>"
    ]
}

List peers with open connections.

Response example:

{
    "Peers": [
        {
            "Addr": "<string>"
            "Peer": "<string>"
            "Latency": "<string>"
            "Muxer": "<string>"
            "Streams": [
                {
                    "Protocol": "<string>"
                }
            ]
        }
    ]
}

Import a tar file into ipfs.

Response example:

{
    "Name": "<string>"
    "Hash": "<string>"
    "Bytes": "<int64>"
    "Size": "<string>"
}

Export a tar file from IPFS.

Show ipfs version information.

Response example:

{
    "Version": "<string>"
    "Commit": "<string>"
    "Repo": "<string>"
    "System": "<string>"
    "Golang": "<string>"
}