API docs by Redocly

Logos Storage API (0.0.1)

Download OpenAPI specification:

List of endpoints and interfaces available to Logos Storage API users

Data

Data operations

Lists manifest CIDs stored locally in node.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Upload a file in a streaming manner. Once finished, the file is stored in the node and can be retrieved by any node in the network using the returned CID.

Authorizations:
None
query Parameters
advertise
boolean
Default: true

When false, the dataset is neither announced to the DHT nor served to peers. Defaults to true.

header Parameters
content-type
string
Example: image/png

The content type of the file. Must be valid.

content-disposition
string
Example: attachment; filename="storage.png"

The content disposition used to send the filename.

Request Body schema: application/octet-stream
string <binary>

Responses

Download a file from the local node in a streaming manner. If the file is not available locally, a 404 is returned.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

Responses

Deletes either a single block or an entire dataset from the local node.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

Block or dataset to be deleted.

Responses

Download a file from the network to the local node if it's not available locally. Note: Download is performed async. Call can return before download is completed.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

query Parameters
advertise
boolean
Default: true

When false, the dataset is neither announced to the DHT nor served to peers. Defaults to true.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "manifest": {
    }
}

Download a file from the network in a streaming manner. If the file is not available locally, it will be retrieved from other nodes in the network if able.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

query Parameters
advertise
boolean
Default: true

When false, the dataset is neither announced to the DHT nor served to peers. Defaults to true.

Responses

Download only the dataset manifest from the network to the local node if it's not available locally.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File for which the manifest is to be downloaded.

query Parameters
advertise
boolean
Default: true

When false, the dataset is neither announced to the DHT nor served to peers. Defaults to true.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "manifest": {
    }
}

Check whether the dataset is announced to the DHT and served to peers.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

Dataset to be checked.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "advertise": true
}

Announce the dataset to the DHT and serve it to peers, or stop doing both. Already published DHT records are not withdrawn, they stop being republished and expire.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

Dataset to be announced or hidden.

query Parameters
advertise
required
boolean

When false, the dataset is neither announced to the DHT nor served to peers.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "advertise": true
}

Check if a block identified by CID exists in the local node.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

CID of the block to check.

Responses

Response samples

Content type
application/json
{
  • "has": true
}

Gets a summary of the storage space allocation of the node.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "totalBlocks": 0,
  • "quotaMaxBytes": 0,
  • "quotaUsedBytes": 0,
  • "quotaReservedBytes": 0
}

Node

Node management

Connect to a peer

If addrs param is supplied, it will be used to dial the peer, otherwise the peerId is used to invoke peer discovery, if it succeeds the returned addresses will be used to dial.

Authorizations:
None
path Parameters
peerId
required
string (PeerId)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

Peer that should be dialed.

query Parameters
addrs
Array of strings or null (MultiAddress)
Example: addrs=/ip4/127.0.0.1/tcp/8080

If supplied, it will be used to dial the peer. The address has to target the listening address of the peer, which is /ip4//tcp/, where listen-port is specified with the --listen-port CLI flag and listen-ip with the --listen-ip CLI flag.

Responses

Get Node's SPR

Authorizations:
None

Responses

Response samples

Content type
No sample

Get Node's PeerID

Authorizations:
None

Responses

Response samples

Content type
No sample

Debug

Debugging configuration

Set log level at run time

Authorizations:
None
query Parameters
level
required
string (LogLevel)
Example: level=DEBUG

One of the log levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL

Responses

Gets node information

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "id": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "addrs": [
    ],
  • "spr": "string",
  • "libp2pPubKey": "string",
  • "mixPubKey": "string",
  • "table": {
    },
  • "storage": {
    },
  • "nat": {
    },
  • "connections": [
    ]
}