IPFS API

We provide private IFPS services. You can use the private IPFS service by referring to this document.

REST API

It exposes the HTTP API that allows you to control the private IPFS node and run the same commands you can from the command line.

Endpoint

Real Server : https://api.vixco.net/v1

Test Server : https://test1-api.vixco.net/v1

Status Codes

Status codes used at the RPC layer are simple:

  • 200 - The request was processed or is being processed (streaming)

  • 500 - RPC endpoint returned an error

  • 400 - Malformed RPC, argument type error, etc

  • 403 - RPC call forbidden

  • 404 - RPC endpoint doesn't exist

  • 405 - HTTP Method Not Allowed

Status code 500 means that the function does exist, but private IPFS was not able to fulfill the request because of an error. To know that reason, you have to look at the the error message that is usually returned with the body of the response.

Streaming endpoints fail as above, unless they have started streaming. That means they will have sent a 200 status code already. If an error happens during the stream, it will be included in a Trailer response header (some endpoints may additionally include an error in the last streamed object).

A 405 error may mean that you are using the wrong HTTP method (i.e. GET instead of POST), or that you are not allowed to call that method (i.e. due to CORS restrictions when making a request from a browser)

Gateway

The priavte IPFS deployment seeks to include native support for all popular browsers and tools. Gateways provide workarounds for applications that do not yet support IPFS natively. For example, errors occur when a browser that does not support IPFS attempts access to IPFS content in the canonical form of ipfs://{CID}/{optional path to resource}. Other tools that rely solely on HTTP encounter similar errors in accessing IPFS content in canonical form, such as Curl (opens new window)and Wget (opens new window).

This gateway provide an HTTP-based service that allows IPFS-ignorant browsers and tools to access private IPFS content.

If you add a file or directory into private IPFS, you can view them in the browser.

PreviousPoints (REST)NextAPI References

Last updated