IPFS

Decentralized file storage via the InterPlanetary File System.

Add file to IPFS.

post

Add file to IPFS.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

binary/octet-stream

string · binaryOptional

Responses

201

File added successfully.

application/json

stringOptionalExample: bafkreibes2bxau2me5o75cxny5mj23ckztpcumoskewz73z52cpankttnm

400

Bad request.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Body content in request is empty.

application/json

500

Internal server error.

application/json

post/ipfs/file

HTTPcURLJavaScriptPython

POST /api/v1/ipfs/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"

bafkreibes2bxau2me5o75cxny5mj23ckztpcumoskewz73z52cpankttnm

Add file to IPFS directly.

post

Add file to IPFS directly.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

binary/octet-stream

string · binaryOptional

Responses

201

File added successfully.

application/json

stringOptionalExample: bafkreibes2bxau2me5o75cxny5mj23ckztpcumoskewz73z52cpankttnm

400

Bad request.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Body content in request is empty.

application/json

500

Internal server error.

application/json

post/ipfs/file/direct

HTTPcURLJavaScriptPython

POST /api/v1/ipfs/file/direct HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"

bafkreibes2bxau2me5o75cxny5mj23ckztpcumoskewz73z52cpankttnm

Add file to local IPFS simulation for dry run mode.

post

Add file to local IPFS simulation for dry run mode.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy id

Example: 69aeb71ef8c5b278e3bab4e5

Body

binary/octet-stream

string · binaryOptional

Responses

201

File added successfully.

application/json

stringOptionalExample: 69c115c3892ada2bac183377

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Body content in request is empty.

application/json

500

Internal server error.

application/json

post/ipfs/file/dry-run/{policyId}

HTTPcURLJavaScriptPython

POST /api/v1/ipfs/file/dry-run/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"

69c115c3892ada2bac183377

Get file from IPFS.

get

Get file from IPFS.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cidstringRequired

File cid

Example: bafkreibes2bxau2me5o75cxny5mj23ckztpcumoskewz73z52cpankttnm

Responses

200

Successful operation. Returns file content.

application/octet-stream

string · binaryOptional

401

Unauthorized request.

application/octet-stream

403

Forbidden

application/octet-stream

404

File is not found.

application/octet-stream

500

Internal server error.

application/octet-stream

get/ipfs/file/{cid}

HTTPcURLJavaScriptPython

GET /api/v1/ipfs/file/{cid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Remove file from IPFS.

delete

Remove file from IPFS.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cidstringRequired

File cid

Responses

200

Successful operation.

application/json

object · nullableOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete/ipfs/file/{cid}

HTTPcURLJavaScriptPython

DELETE /api/v1/ipfs/file/{cid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get file from local IPFS simulation for dry-run mode

get

Get file from local IPFS simulation for dry-run mode

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cidstringRequired

File cid

Example: 69c116d7892ada2bac1833a6

Responses

200

Successful operation. Returns file content.

application/octet-stream

string · binaryOptional

401

Unauthorized request.

application/octet-stream

403

Forbidden

application/octet-stream

404

File is not found.

application/octet-stream

500

Internal server error.

application/octet-stream

get/ipfs/file/{cid}/dry-run

HTTPcURLJavaScriptPython

GET /api/v1/ipfs/file/{cid}/dry-run HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary