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

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/add

Authorization

api_key

Query parameters

Body

multipart/form-data

fileNamestring (binary)

Response

200400500

File uploaded

Body

application/json

Bytesnumber

Example: 2454

Hashstring

Example: "QmSMPFa2op3HqGv7bbpm1GkzPnuHP9cx2rQXiqN1"

Namestring

Example: "test"

Sizestring

Example: 1049

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/add', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

{
  "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

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/addByUrl

Authorization

api_key

Query parameters

Response

200400500

File uploaded

Body

application/json

Bytesnumber

Example: 2454

Hashstring

Example: "QmSMPFa2op3HqGv7bbpm1GkzPnuHP9cx2rQXiqN1"

Namestring

Example: "test"

Sizestring

Example: 1049

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/addByUrl?url=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "Bytes": 2454,
  "Hash": "QmSMPFa2op3HqGv7bbpm1GkzPnuHP9cx2rQXiqN1",
  "Name": "test",
  "Size": 1049
}

List directory contents for Unix filesystem objects

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/ls

Authorization

api_key

Query parameters

Response

200500

List directory contents

Body

application/json

Objectsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/ls?arg=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "Objects": [
    {
      "Hash": "QmPJwu6iYBmj4eferq3UJK3uEEii2gKk",
      "Links": [
        {
          "Hash": "QmPJwu6iYBmj4eferq3UJK3uEEii2gKk",
          "Name": "test",
          "Size": 1049,
          "Target": "",
          "Type": 2
        }
      ]
    }
  ]
}

Show IPFS object data

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/cat

Authorization

api_key

Query parameters

Response

200500

File data

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/cat?arg=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

500

{
  "errorCode": "ServerError",
  "message": "General server error",
  "correlation-id": "bfd808d8-e441-4441-b943-7d3958c1f4a7"
}

Pin objects to local storage

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/add

Authorization

api_key

Query parameters

Response

200500

Newly added pins list

Body

application/json

Pinsarray of string

Progressnumber

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/add?arg=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "Pins": [
    "text"
  ],
  "Progress": 0
}

Remove object from pin-list. By default garbage collection is called after pin is removed

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/rm

Authorization

api_key

Query parameters

Response

200500

Removed pins list

Body

application/json

Pinsarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/rm?arg=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "Pins": [
    "text"
  ]
}

List objects pinned to local storage

POSThttps://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/ls

Authorization

api_key

Query parameters

Response

200500

Pinned list

Body

application/json

PinLsListobject

PinLsObjectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://<networkorgid>.ipfs-<region>.<publicdomain>/ipfs/pin/ls?arg=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "PinLsList": {
    "Keys": {
      "Sample": {
        "Type": "test"
      }
    }
  },
  "PinLsObject": {
    "Cid": "QmPJwu6iYBmj4eferq3UJK3uEEi",
    "Type": "test"
  }
}