IPFS
You can access the Rest API through the Swagger UI from the App API section. Navigate to Network -> Deployed Apps -> App -> IPFS API
base url:
https://<membership_id>.ipfs-<region>.spydra.app
Get the base URL from Network -> Deployed Apps -> App -> IPFS API page.
Select your organization at the top right of this page.Uploads a file to IPFS using the given URL, with a maximum accepted size of 4MB. For file size larger than 4MB use the /ipfs/addByUrl endpoint
Write minimal output
Write only final hash
Write no output
Stream progress data
Use trickle-dag format for dag generation
Only chunk and hash - do not write to disk
Wrap files with a directory object
Chunking algorithm, size-[bytes], rabin-[min]-[avg]-[max] or buzhash. Default value is size-262144
Use raw blocks for leaf nodes
Add the file using filestore. Implies raw-leaves
Check the filestore for pre-existing blocks
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
Hash function to use. Implies CIDv1 if not sha2-256. Default value is sha2-256
Inline small blocks into CIDs
Maximum block size to inline. Default value is 32
Pin locally to protect added files from garbage collection. Default value is true
Add reference to Files API (MFS) at the provided path
POST /ipfs/add HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 21
{
"fileName": "binary"
}{
"Bytes": 2454,
"Hash": "QmSMPFa2op3HqGv7bbpm1GkzPnuHP9cx2rQXiqN1",
"Name": "test",
"Size": 1049
}Uploads a file to IPFS using the given URL, with a maximum accepted size of 512MB. By default wrap-with-directory it is set to true. It is necessary to be able to persist file name in ipfs
File's URL
Write minimal output
Write only final hash
Write no output
Stream progress data
Use trickle-dag format for dag generation
Only chunk and hash - do not write to disk
Wrap files with a directory object
Chunking algorithm, size-[bytes], rabin-[min]-[avg]-[max] or buzhash. Default value is size-262144
Use raw blocks for leaf nodes
Add the file using filestore. Implies raw-leaves
Check the filestore for pre-existing blocks
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
Hash function to use. Implies CIDv1 if not sha2-256. Default value is sha2-256
Inline small blocks into CIDs
Maximum block size to inline. Default value is 32
Pin locally to protect added files from garbage collection. Default value is true
Add reference to Files API (MFS) at the provided path
POST /ipfs/addByUrl?url=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"Bytes": 2454,
"Hash": "QmSMPFa2op3HqGv7bbpm1GkzPnuHP9cx2rQXiqN1",
"Name": "test",
"Size": 1049
}List directory contents for Unix filesystem objects
The path to the IPFS object(s) to list links from
Print table headers (Hash, Size, Name)
Resolve linked objects to find out their types. Default value is true
Resolve linked objects to find out their file size. Default value is true
Enable experimental streaming of directory entries as they are traversed
POST /ipfs/ls?arg=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"Objects": [
{
"Hash": "QmPJwu6iYBmj4eferq3UJK3uEEii2gKk",
"Links": [
{
"Hash": "QmPJwu6iYBmj4eferq3UJK3uEEii2gKk",
"Name": "test",
"Size": 1049,
"Target": "",
"Type": 2
}
]
}
]
}Show IPFS object data
The path to the IPFS object(s) to be outputted
Overrides garbage collection when retrieving files. By default, when retrieving files, garbage collection is triggered to prevent non-pinned files from being cached or stored in the retrieving node to reduce storage requirements
Byte offset to begin reading from
Maximum number of bytes to read
Stream progress data. Default value is true
POST /ipfs/cat?arg=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Pin objects to local storage
Path to object(s) to be pinned
Recursively pin the object linked to by the specified object(s). Default value is true
Show progress
POST /ipfs/pin/add?arg=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"Pins": [
"text"
],
"Progress": 1
}Remove object from pin-list. By default garbage collection is called after pin is removed
Path to object(s) to be unpinned
Allows you to override the default behaviour of garbage collection when removing a pin. By default, after removing a pin using the pin/rm API, the garbage collection process is automatically triggered. However, it is important to note that using the gc parameter is discouraged for regular usage
Recursively unpin the object linked to by the specified object(s). Default value is true
POST /ipfs/pin/rm?arg=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"Pins": [
"text"
]
}List objects pinned to local storage
Path to object(s) to be listed
The type of pinned keys to list. Can be "direct", "indirect", "recursive", or "all". Default value is all
Write just hashes of objects
Enable streaming of pins as they are discovered
POST /ipfs/pin/ls?arg=text HTTP/1.1
Host: <networkorgid>.ipfs-<region>.<publicdomain>
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"PinLsList": {
"Keys": {
"Sample": {
"Type": "test"
}
}
},
"PinLsObject": {
"Cid": "QmPJwu6iYBmj4eferq3UJK3uEEi",
"Type": "test"
}
}Last updated
Was this helpful?