List volumes - microsandbox

GET

/

v1

/

volumes

List volumes

curl --request GET \
  --url https://api.microsandbox.dev/v1/volumes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.microsandbox.dev/v1/volumes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.microsandbox.dev/v1/volumes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.microsandbox.dev/v1/volumes"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.microsandbox.dev/v1/volumes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "labels": {},
    "storage": "block",
    "updated_at": "2023-11-07T05:31:56Z",
    "capacity_bytes": 1,
    "name": "<string>",
    "used_bytes": 1
  }
]

{
  "error": {
    "code": "invalid_api_key",
    "message": "unauthorized",
    "details": null
  }
}

Authorizations

Authorization

string

header

required

Organization API key (msb_…) - org-scoped programmatic access.

Response

The org's volumes

created_at

string<date-time>

required

id

string<uuid>

required

kind

enum<string>

required

host - the org's shared host disk (not deletable); managed - a user-created named volume.

Available options:

host,

managed

labels

object

required

User-defined labels (empty object when none set).

Show child attributes

status

enum<string>

required

Lifecycle status of a volume.

Available options:

active,

deleting

storage

enum<string>

required

How the volume is physically backed (block today).

Available options:

block

updated_at

string<date-time>

required

capacity_bytes

integer<int64> | null

The volume's configured per-volume storage cap in bytes, or null when no cap is set (#496). Derived from the stored capacity_gib (the user's configured intent) - the effective ceiling is min(this, org cap).

Required range: x >= 0

name

string | null

User-facing name. null for the host volume (it has no name; it's identified by kind).

used_bytes

integer<int64> | null

Bytes currently used under this volume's subtree. null when usage is unavailable - the usage service is disabled or unreachable (list degrades gracefully rather than failing) - or on create/delete, which don't sample it.

Required range: x >= 0

Set or clear a volume's storage cap

⌘I

List volumes

curl --request GET \
  --url https://api.microsandbox.dev/v1/volumes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.microsandbox.dev/v1/volumes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.microsandbox.dev/v1/volumes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.microsandbox.dev/v1/volumes"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.microsandbox.dev/v1/volumes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "labels": {},
    "storage": "block",
    "updated_at": "2023-11-07T05:31:56Z",
    "capacity_bytes": 1,
    "name": "<string>",
    "used_bytes": 1
  }
]

{
  "error": {
    "code": "invalid_api_key",
    "message": "unauthorized",
    "details": null
  }
}