Simple details about the storage provider.
name
type
desc.
status
string
Will always say "online" due to the response being available
address
string
The address of the storage provider
Lists the version of the software the storage provider is running.
name
type
desc.
version
string
The git tag version (ex. v1.0.2)
build
string
The git commit
chain-id
string
The tendermint chain-id the provider is connected to
Downloads a file from the Jackal Protocol
name
type
merkle
hex string
name
type
desc.
file
file
The requested file
Lists every file stored on this provider.
name
type
desc.
files
string array
Every merkle hash stored on this provider, as hex strings
Lists every file stored on this provider.
name
type
desc.
files
string array
Every merkle hash stored on this provider, as hex strings
List IPFS Peers /ipfs/peers
Lists every connected IPFS peer ID.
name
type
desc.
peers
string array
Every IPFS peer ID in base64
List IPFS Peers /ipfs/hosts
Lists the hosts this storage provider is accessible from.
name
type
desc.
hosts
string array
List of multiaddrs that this provider can be reached at
List IPFS Files /ipfs/cids
Lists every file stored on this device as an IFPS CID.
name
type
desc.
cids
string array
List of IPFS CIDs stored on this provider
Map IPFS & Jackal File IDs /ipfs/cid_map
Returns a map of all files' Merkles as hex strings paired to IPFS CIDs.
name
type
desc.
cid_map
map <string, string>
Mapping file merkles as hex strings to IPFS CIDs
Dump Database State /dump
Dumps the entire database state to JSON.
name
type
desc.
dump
JSON Object
Entire DB as object
Prometheus formatted metrics.
name
type
desc.
metrics
Prometheus File
Prometheus metrics dump
Upload a file to Jackal.
Parameters (multi-part form format)
name
type
sender
Jackal Address string
merkle
Merkle Root of file in hex string
start
Start block of file deal
name
type
desc.
merkle
Hex String
Merkle of file
Owner
Jackal Address String
Owner of file deal
Start
Integer
Start block of file deal
CID
IPFS CID String
IPFS CID of file deal
Create IPFS Folder /ipfs/make_folder
Create an IPFS folder mapping.
name
type
n/a
Comma delimited list of IPFS CIDs
name
type
desc.
CID
IPFS CID String
IPFS CID of folder