NxtFi
  • NxtFi Blockchain
  • Testing Network
  • Block Viewer
  • Playground
  • Authentication
  • Create New Block
  • Blockchain Libraries
    • NxtFi Tools
    • Javascript - CreateBlock
  • Smart Contracts
  • The Storage System
  • Upload Media Files
  • Blockchain API Interactions
  • Access Control Layer
    • How it Works
    • Syntax & Smart Contract requirements
    • Example
  • API - Listing Files
  • API Reference
    • Get node health
    • Get the last block
    • Get block information by hash
    • Get block information by timestamp
    • Get block information by height
    • Get files from storage by scope
    • Storage tracking interactions
    • Storage tracking timestamp block info
    • Submit new block
    • Presign media file upload
Powered by GitBook
On this page
  • If no query string is declared, default listing is ascendent-alphabetical order.
  • Listing trace interaction:

API - Listing Files

Listing results on https calls

PreviousExampleNextGet node health

Last updated 1 year ago

When query calls point to a directory, as mentioned in the API interaction section, they will need to be ended with a '/'.

Getting a list of files from a directory enables optional query string specifications in order to manage and organize these lists according to the following syntax:

https://test-001-node.cloud.nxtfi.org/v2/<ENDPOINT>/?raw=<true>&startafter=<key>&maxkeys=<number>

If no query string is declared, default listing is ascendent-alphabetical order.

GET https://test-001-node.cloud.nxtfi.org/v2/<ENDPOINT>/?<query-string-options-and-values>

If a query string is declared in order to be valid must have a = between the query name and its value

Query Parameters

Name
Type
Description

raw

Boolean

returns listed items in native structure

startafter

String

Return keys starting after designated value. Alphabetical order.

maxkeys

Number

Return designated max keys values. Default and max on each query 1000 items.

Listing trace interaction:

The system for monitoring interactions is listed in a slightly different way. For more information on tracing, please refer to the section.

Interactions with the NxtFi file system are stored in tracking directories that point to a specific file. This means that a single stored value may have a list of tracking files related to its manipulation.

Therefore, when listing the tracking information of a specific file, its query must include "/" endings as they are fixed directories to their "parent" element.

For example SUCCESS:

https://test-001-node.cloud.nxtfi.org/v2/_trace/<scope>/<fileName>/

https://test-001-node.cloud.nxtfi.org/v2/_trace/<scope>/<fileName>/<timestamp>

For example {"error": "notFound"}:

https://test-001-node.cloud.nxtfi.org/v2/_trace/<scope>/<filename>

https://test-001-node.cloud.nxtfi.org/v2/_trace/<scope>/<file>/timestamp/

Storage tracking interactions