Volumes Index
curl --request GET \
--url https://{host}/api/volumes \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/volumes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/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://{host}/api/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://{host}/api/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))
}HttpResponse<String> response = Unirest.get("https://{host}/api/volumes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/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{
"volumes": [
{
"id": "<string>",
"owner": "<string>",
"name": "<string>",
"visibility": "private",
"description": "<string>",
"created_at": 123,
"allow_download": true,
"allow_use": true,
"usable_by": [
"<string>"
],
"allow_preview": true,
"watermark": true,
"watermark_text": "<string>",
"classification": "<string>",
"backing": "<string>",
"connection": "<string>",
"source_path": "<string>",
"external": true,
"measured": {
"bytes": 123,
"objects": 123,
"partial": true,
"owned": true,
"measured_at": 123
}
}
],
"measured_at": 0,
"stale": true
}Volumes Index
Volumes the caller may reference: public ones, their own, all for admins.
Each row carries its measured size. That used to be impossible here: there is no aggregate to read, so the only way to answer it was a full listing per volume — two hundred round trips for a page of fifty. The background measurement is that missing aggregate, so the number is now a lookup rather than a walk, and the listing costs what it always did.
null where a volume has not been measured yet. Rendered as “not measured”,
never as zero: a volume reading 0 B because a background role has not run is
a page telling somebody their upload did not land.
GET
/
api
/
volumes
Volumes Index
curl --request GET \
--url https://{host}/api/volumes \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/volumes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/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://{host}/api/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://{host}/api/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))
}HttpResponse<String> response = Unirest.get("https://{host}/api/volumes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/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{
"volumes": [
{
"id": "<string>",
"owner": "<string>",
"name": "<string>",
"visibility": "private",
"description": "<string>",
"created_at": 123,
"allow_download": true,
"allow_use": true,
"usable_by": [
"<string>"
],
"allow_preview": true,
"watermark": true,
"watermark_text": "<string>",
"classification": "<string>",
"backing": "<string>",
"connection": "<string>",
"source_path": "<string>",
"external": true,
"measured": {
"bytes": 123,
"objects": 123,
"partial": true,
"owned": true,
"measured_at": 123
}
}
],
"measured_at": 0,
"stale": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.