get__bucket_{bucketId}_status

GET /bucket/{bucketId}/status

Get Bucket Status

Retrieve the current status of a specific storage bucket, including information about all connected nodes, their latency, and operational status.

Note: This endpoint respects workspace access controls. Users can only access buckets within their accessible workspaces.

TypeScript Client Library

public getStorageBucketStatus = async (bucketId: string): Promise<StorageBucketStatusResponse> => {
  return this.makeRequest<StorageBucketStatusResponse>(`bucket/${bucketId}/status`, 'GET', null);
};

Code Samples

Shell

# You can also use wget
curl -X GET https://backend.flashback.tech/bucket/{bucketId}/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

GET https://backend.flashback.tech/bucket/{bucketId}/status HTTP/1.1
Host: localhost:3000
Accept: application/json

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/bucket/{bucketId}/status',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/bucket/{bucketId}/status',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://backend.flashback.tech/bucket/{bucketId}/status', headers = headers)

print(r.json())

PHP

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://backend.flashback.tech/bucket/{bucketId}/status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getResponse()->getBody()->getContents());
 }

Java

URL obj = new URL("https://backend.flashback.tech/bucket/{bucketId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/bucket/{bucketId}/status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Parameters

Name	In	Type	Required	Description
bucketId	path	string	true	Unique identifier of the bucket

Example responses

200 Response

{
  "bucketId": "550e8400-e29b-41d4-a716-446655440000",
  "nodeStatus": [
    {
      "ip": "192.168.1.100",
      "region": "us-east-1",
      "version": "1.2.3",
      "status": "ONLINE",
      "latency_ms": 45,
      "lastUpdated": "2024-01-15T10:30:00Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Bucket status retrieved	Inline
403	Forbidden	Insufficient permissions	Inline
404	Not Found	Bucket or user not found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» bucketId	string	false	none	Unique identifier for the bucket
» nodeStatus	[object]	false	none	Array of node status information
»» ip	string	false	none	IP address of the node
»» region	string	false	none	Geographic region of the node
»» version	string	false	none	Software version running on the node
»» status	string	false	none	Current operational status of the node
»» latency_ms	integer	false	none	Latency to the node in milliseconds
»» lastUpdated	string(date-time)	false	none	Timestamp of last status update

Status Code 403

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» message	string	false	none	none

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth