Buckets

List accessible buckets

Returns the buckets the key’s company can reach. Use it to discover the bucketId that file and folder calls require.

A key restricted to specific buckets sees only those buckets in the list. The list is not paginated.

datacenterId is the bucket’s location binding. Treat it as an opaque identifier: available locations are selected at bucket creation in the dashboard, and the platform’s datacenter and region routes are not part of the API-key surface.

Required scope: buckets:read.

GET

buckets

all

List accessible buckets

curl --request GET \
  --url https://api.everabyte.io/api/buckets/all \
  --header 'X-Public-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'X-Public-Key': '<api-key>', 'X-Secret-Key': '<api-key>'}
};

fetch('https://api.everabyte.io/api/buckets/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'GET',
  headers: {'X-Public-Key': '<api-key>', 'X-Secret-Key': '<api-key>'}
};

fetch('https://api.everabyte.io/api/buckets/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.everabyte.io/api/buckets/all"

headers = {
    "X-Public-Key": "<api-key>",
    "X-Secret-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.everabyte.io/api/buckets/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Public-Key: <api-key>",
    "X-Secret-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.everabyte.io/api/buckets/all"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Public-Key", "<api-key>")
	req.Header.Add("X-Secret-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": 200,
  "message": "Buckets retrieved",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "code": "<string>",
      "retentionPeriod": "<string>",
      "datacenterId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

Authorizations

X-Public-Key

string

header

required

Public half of the company API key. Format: pk_ followed by 64 hexadecimal characters.

X-Secret-Key

string

header

required

Secret half of the company API key. Format: sk_ followed by 64 hexadecimal characters. Stored as a hash server-side and shown only at creation or rotation.

Response

Bucket list.

status

integer

required

Example:

200

message

string

required

Example:

"Buckets retrieved"

data

object[]

required

Show child attributes

⌘I

List accessible buckets

curl --request GET \
  --url https://api.everabyte.io/api/buckets/all \
  --header 'X-Public-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'X-Public-Key': '<api-key>', 'X-Secret-Key': '<api-key>'}
};

fetch('https://api.everabyte.io/api/buckets/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'GET',
  headers: {'X-Public-Key': '<api-key>', 'X-Secret-Key': '<api-key>'}
};

fetch('https://api.everabyte.io/api/buckets/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.everabyte.io/api/buckets/all"

headers = {
    "X-Public-Key": "<api-key>",
    "X-Secret-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.everabyte.io/api/buckets/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Public-Key: <api-key>",
    "X-Secret-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.everabyte.io/api/buckets/all"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Public-Key", "<api-key>")
	req.Header.Add("X-Secret-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": 200,
  "message": "Buckets retrieved",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "code": "<string>",
      "retentionPeriod": "<string>",
      "datacenterId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

{
  "status": 123,
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "code": "<string>",
  "data": {}
}

Overview

Endpoint Guides

Buckets

Files

Folders

List accessible buckets

Authorizations

Response