post__bucket_{bucketId}_validate

POST /bucket/{bucketId}/validate

Validate Bucket Accessibility

Test the accessibility and connectivity of a specific storage bucket by checking if it can be reached through available online nodes. This endpoint returns the current status and latency information.

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

TypeScript Client Library

public validateStorageBucket = async (bucketId: string, data: ValidateBucketRequest): Promise<ValidateBucketResponse> => {
  return this.makeRequest<ValidateBucketResponse>(`bucket/${bucketId}/validate`, 'POST', data);
};

Code Samples

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

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print(r.json())

URL obj = new URL("https://backend.flashback.tech/bucket/{bucketId}/validate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Parameters

Name

Type

Required

Description

bucketId

path

string

true

Unique identifier of the bucket

Example responses

200 Response

{
  "success": true,
  "message": "Bucket is accessible",
  "latency_ms": 45,
  "status": "ONLINE"
}

Responses

Status

Meaning

Description

Schema

200

Bucket validation successful

Inline

400

Bad Request

Validation failed

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

» success

boolean

false

none

Operation success status

» message

string

false

none

Human-readable validation result message

» latency_ms

integer

false

none

Latency to the bucket in milliseconds

» status

string

false

none

Current operational status of the bucket

Status Code 400

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Status Code 403

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Status Code 404

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

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

Previousdelete__bucket_{bucketId}NextRepo Storage API Key

Last updated 6 months ago

Was this helpful?

hashtagTypeScript Client Library

hashtagCode Samples

hashtagParameters

hashtagResponses

hashtagResponse Schema

TypeScript Client Library

Code Samples

Parameters

Responses

Response Schema