List All Volumes

GET

orgs

{org_slug}

volumes

List All Volumes

curl --request GET \
  --url https://api.machines.dev/v1/orgs/{org_slug}/volumes

const options = {method: 'GET'};

fetch('https://api.machines.dev/v1/orgs/{org_slug}/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/orgs/{org_slug}/volumes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/orgs/{org_slug}/volumes"

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

	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/orgs/{org_slug}/volumes")

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

request = Net::HTTP::Get.new(url)

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

{
  "last_updated_at": "<string>",
  "last_volume_id": "<string>",
  "next_cursor": "<string>",
  "volumes": [
    {
      "app_name": "<string>",
      "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",
      "updated_at": "<string>",
      "zone": "<string>"
    }
  ]
}

Path Parameters

org_slug

string

required

Fly Organization Slug

Query Parameters

include_deleted

boolean

Include deleted volumes

region

string

Region filter

state

string

Comma separated list of volume states to filter

summary

boolean

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

updated_after

string

Only return volumes updated after this time. Timestamp must be in the RFC 3339 format

cursor

string

Pagination cursor from previous response (takes precedence over updated_after)

limit

integer

The number of volumes to fetch (max of 1000). This limit is advisory. Responses may be shorter, even when more volumes remain. If omitted, the maximum is used

Response

200 - application/json

last_updated_at

string

last_volume_id

string

next_cursor

string

volumes

object[]

Show child attributes

⌘I

List All Volumes

curl --request GET \
  --url https://api.machines.dev/v1/orgs/{org_slug}/volumes

const options = {method: 'GET'};

fetch('https://api.machines.dev/v1/orgs/{org_slug}/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/orgs/{org_slug}/volumes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/orgs/{org_slug}/volumes"

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

	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/orgs/{org_slug}/volumes")

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

request = Net::HTTP::Get.new(url)

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

{
  "last_updated_at": "<string>",
  "last_volume_id": "<string>",
  "next_cursor": "<string>",
  "volumes": [
    {
      "app_name": "<string>",
      "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",
      "updated_at": "<string>",
      "zone": "<string>"
    }
  ]
}