Check data chunk status

GET

/api/v1/storage/status/{userAddr}/{chunkID}

const url = 'http://localhost:8080/api/v1/storage/status/example/1';
const options = {method: 'GET', headers: {'X-Signature': '<X-Signature>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/storage/status/example/1 \
  --header 'X-Signature: <X-Signature>'

Check the status and health of a data chunk in the distributed storage network. Returns information about shard availability and data health.

Authorizations

EthereumSignature
LegacyECDSA

Parameters

Path Parameters

userAddr

required

string

/^0x[a-fA-F0-9]{40}$/

Ethereum address (0x…)

chunkID

required

integer

Chunk identifier

Responses

200

Status check successful

application/json

object

success

boolean

userAddr

string

chunkID

integer

exists

Whether the chunk exists

boolean

health

Health status of the chunk

string

Allowed values: excellent good degraded critical lost none

healthScore

Health score (0.0 - 1.0)

number format: float

<= 1

availableShards

Number of available shards

integer

totalShards

Total number of shards

integer

minRequiredShards

Minimum shards required for recovery

integer

shardStatus

Array<object>

object

shardIndex

Index of the shard

integer

available

Whether the shard is available

boolean

nodeId

Node ID storing this shard

string

error

Error message if shard is unavailable

string

checkedAt

Status check timestamp

string format: date-time

Example

{
  "success": true,
  "userAddr": "0x1234567890123456789012345678901234567890",
  "chunkID": 1,
  "exists": true,
  "health": "excellent",
  "healthScore": 1,
  "availableShards": 15,
  "totalShards": 15,
  "minRequiredShards": 10,
  "shardStatus": [
    {
      "shardIndex": 0,
      "available": true,
      "nodeId": "QmNode1..."
    }
  ],
  "checkedAt": "2025-12-10T12:00:00Z"
}

400

Bad Request - Invalid parameters

application/json

object

error

Error type

string

message

Human-readable error description

string

code

Optional error code

string

Example

{
  "error": "Invalid request",
  "message": "User address must be a valid Ethereum address (0x...)"
}

500

Internal Server Error

application/json

object

error

Error type

string

message

Human-readable error description

string

code

Optional error code

string

Example

{
  "error": "Internal server error",
  "message": "An unexpected error occurred"
}