List Volumes

Lists all volume templates and their instances for an application, including usage statistics.

GET /apps/{appId}/volumes

List Volumes

cURL

curl --request GET \
  --url https://api.bunny.net/mc/apps/{appId}/volumes \
  --header 'AccessKey: <api-key>'

import requests

url = "https://api.bunny.net/mc/apps/{appId}/volumes"

headers = {"AccessKey": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/mc/apps/{appId}/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.bunny.net/mc/apps/{appId}/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 => [
    "AccessKey: <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.bunny.net/mc/apps/{appId}/volumes"

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

	req.Header.Add("AccessKey", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bunny.net/mc/apps/{appId}/volumes")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/mc/apps/{appId}/volumes")

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

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

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

200

{
  "items": [
    {
      "name": "<string>",
      "id": "<string>",
      "size": 5,
      "totalUsage": 123,
      "totalInstancesCount": 123,
      "attachedInstancesCount": 123,
      "containersCount": 123,
      "volumeInstances": [
        {
          "id": "<string>",
          "attachedPods": [
            "<string>"
          ],
          "attachedContainers": [
            "<string>"
          ],
          "region": "<string>",
          "size": 5,
          "usage": 123,
          "set": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "totalItems": 123
  },
  "cursor": "<string>",
  "summary": {
    "totalPods": 123,
    "totalContainers": 123,
    "totalStorage": 123
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "id": "<string>"
}

Authorizations

AccessKey · string · header · required

Please enter a valid personal API key.

Path Parameters

appId · string · required

Response

200

application/json

Volumes were successfully retrieved.

List volumes response

items · object[]

Show child attributes

meta · object

Show child attributes

cursor · string | null

summary · object

Show child attributes