List Volumes - Fly.io

GET

apps

{app_name}

volumes

List Volumes

curl --request GET \
  --url https://api.machines.dev/v1/apps/{app_name}/volumes \
  --header 'Authorization: <api-key>'

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

fetch('https://api.machines.dev/v1/apps/{app_name}/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.machines.dev/v1/apps/{app_name}/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: <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.machines.dev/v1/apps/{app_name}/volumes"

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

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

	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.machines.dev/v1/apps/{app_name}/volumes")

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

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

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

[
  {
    "attached_alloc_id": "<string>",
    "attached_machine_id": "<string>",
    "auto_backup_enabled": true,
    "block_size": 123,
    "blocks": 123,
    "blocks_avail": 123,
    "blocks_free": 123,
    "bytes_total": 123,
    "bytes_used": 123,
    "created_at": "<string>",
    "encrypted": true,
    "fstype": "<string>",
    "host_features": [
      "<string>"
    ],
    "host_status": "ok",
    "id": "<string>",
    "name": "<string>",
    "region": "<string>",
    "required_host_features": [
      "<string>"
    ],
    "size_gb": 123,
    "snapshot_retention": 123,
    "state": "<string>",
    "type": "local",
    "zone": "<string>"
  }
]

{
  "details": {},
  "error": "<string>",
  "status": "unknown"
}

Authorizations

Authorization

string

header

required

A Fly API token with access to the requested organization or resource. Send it as Authorization: Bearer <Fly API token>.

Path Parameters

app_name

string

required

Fly App Name

Query Parameters

summary

boolean

Only return summary info about volumes (omit blocks, block size, etc)

cursor

string

Value of the fly-next-cursor response header from the previous page. Requires limit.

limit

integer

The number of volumes to fetch (must be between 1 and 1000). Providing a limit enables pagination. This limit is advisory; responses may be shorter, or even empty, even when more volumes remain.

Response

attached_alloc_id

string

attached_machine_id

string

auto_backup_enabled

boolean

block_size

integer

blocks

integer

blocks_avail

integer

blocks_free

integer

bytes_total

integer

bytes_used

integer

created_at

string

encrypted

boolean

fstype

string

host_features

string[]

host_status

enum<string>

Available options:

ok,

unknown,

unreachable

string

name

string

region

string

required_host_features

string[]

size_gb

integer

snapshot_retention

integer

state

string

type

enum<string>

Available options:

local,

cache

zone

string

⌘I

List Volumes

curl --request GET \
  --url https://api.machines.dev/v1/apps/{app_name}/volumes \
  --header 'Authorization: <api-key>'

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

fetch('https://api.machines.dev/v1/apps/{app_name}/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.machines.dev/v1/apps/{app_name}/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: <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.machines.dev/v1/apps/{app_name}/volumes"

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

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

	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.machines.dev/v1/apps/{app_name}/volumes")

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

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

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

[
  {
    "attached_alloc_id": "<string>",
    "attached_machine_id": "<string>",
    "auto_backup_enabled": true,
    "block_size": 123,
    "blocks": 123,
    "blocks_avail": 123,
    "blocks_free": 123,
    "bytes_total": 123,
    "bytes_used": 123,
    "created_at": "<string>",
    "encrypted": true,
    "fstype": "<string>",
    "host_features": [
      "<string>"
    ],
    "host_status": "ok",
    "id": "<string>",
    "name": "<string>",
    "region": "<string>",
    "required_host_features": [
      "<string>"
    ],
    "size_gb": 123,
    "snapshot_retention": 123,
    "state": "<string>",
    "type": "local",
    "zone": "<string>"
  }
]

{
  "details": {},
  "error": "<string>",
  "status": "unknown"
}