API References

Private IPFS for NFT

Add

Add a file or directory to IPFS

POSThttps://test1-api.finenex.net/v1/ipfs/add

Authorization

bearer-key

Query parameters

Body

multipart/form-data

filestring (binary)

Response

200

Add a file or directory to IPFS

Body

application/json

cid*string

The content ID to the IPFS object(s) to be outputted

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/ipfs/add', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "cid": "text"
}

Request Body

This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.

The add command not only allows adding files, but also uploading directories and complex hierarchies.

This happens as follows: Every part in the multipart request is a directory or a file to be added to IPFS.

Directory parts have a special content type application/x-directory. These parts do not carry any data. The part headers look as follows:

Content-Disposition: form-data; name="file"; filename="folderName"
Content-Type: application/x-directory

File parts carry the file payload after the following headers:

Abspath: /absolute/path/to/file.txt
Content-Disposition: form-data; name="file"; filename="folderName%2Ffile.txt"
Content-Type: application/octet-stream

...contents...

The 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.

The 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.

Example

Request

curl -X 'POST' \
  '{endpoint}/ipfs/add' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNDY4ODIsImlhdCI6MTY1MjE2MDQ4Mn0.ceg6PQT9D78h9PtMZR9DrbfiXM3YfGAqUiGqDBNLo-o' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@file.yaml'

Response

{
  "cid": "QmVuLWZ1cmZiujoM9y6r6nd19x9kVEARYa9NABzf6GbxRN"
}

Cat

Show IPFS object data

GEThttps://test1-api.finenex.net/v1/ipfs/{cid}

Authorization

bearer-key

Path parameters

cid*string

The content ID to the IPFS object(s) to be outputted

Query parameters

Response

200

Show IPFS object data

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/ipfs/{cid}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

text

Example

Request

curl -X 'GET' \
  '{endpoint}/ipfs/QmVuLWZ1cmZiujoM9y6r6nd19x9kVEARYa9NABzf6GbxRN' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNDY4ODIsImlhdCI6MTY1MjE2MDQ4Mn0.ceg6PQT9D78h9PtMZR9DrbfiXM3YfGAqUiGqDBNLo-o'

Response

File contents

Get

Save IPFS object data

GEThttps://test1-api.finenex.net/v1/ipfs/{cid}/get

Authorization

bearer-key

Path parameters

cid*string

The content ID to the IPFS object(s) to be outputted

Query parameters

Response

200

Save IPFS object data

Body

application/x-tar

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/ipfs/{cid}/get', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

binary

Example

Request

curl -X 'GET' \
  '{endpoint}/ipfs/QmVuLWZ1cmZiujoM9y6r6nd19x9kVEARYa9NABzf6GbxRN/get?filename=temp' \
  -H 'accept: application/x-tar' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNDY4ODIsImlhdCI6MTY1MjE2MDQ4Mn0.ceg6PQT9D78h9PtMZR9DrbfiXM3YfGAqUiGqDBNLo-o'

Response

Tar file

Id

Show IPFS node id info.

GEThttps://test1-api.finenex.net/v1/ipfs/id

Authorization

bearer-key

Response

200

Show IPFS node id info

Body

application/json

idstring

IPFS Node ID

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/ipfs/id', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "text"
}

Example

Request

curl -X 'GET' \
  '{endpoint}/ipfs/id' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNDY4ODIsImlhdCI6MTY1MjE2MDQ4Mn0.ceg6PQT9D78h9PtMZR9DrbfiXM3YfGAqUiGqDBNLo-o'

Response

{
  "id": "12D3KooWN4tTkHvjMttH77tMtcTBz5HJqEfNveJsnDo828JjHcjL"
}

Version

Show IPFS version information

GEThttps://test1-api.finenex.net/v1/ipfs/version

Authorization

bearer-key

Response

200

Show IPFS version information

Body

application/json

versionstring

IPFS node version

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/ipfs/version', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "version": "text"
}

Example

Request

curl -X 'GET' \
  '{endpoint}/ipfs/version' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNDY4ODIsImlhdCI6MTY1MjE2MDQ4Mn0.ceg6PQT9D78h9PtMZR9DrbfiXM3YfGAqUiGqDBNLo-o'

Response

{
  "version": "0.10.0"
}