List Apps - Fly.io

GET

/

v1

/

apps

List Apps

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

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

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

	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")

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

{
  "apps": [
    {
      "id": "<string>",
      "internal_numeric_id": 123,
      "machine_count": 123,
      "name": "<string>",
      "network": "<string>",
      "network_cidr": "<string>",
      "organization": {
        "internal_numeric_id": 123,
        "name": "<string>",
        "slug": "<string>"
      },
      "status": "<string>",
      "volume_count": 123
    }
  ],
  "next_cursor": "<string>",
  "total_apps": 123
}

{
  "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>.

Query Parameters

org_slug

string

required

The org slug, or 'personal', to filter apps

app_role

string

Filter apps by role

limit

integer

The number of apps to fetch (must be between 1 and 5000). Providing a limit enables pagination. Without it, all apps are returned in one response.

cursor

string

Value of next_cursor from the previous page. Requires limit. Later pages only include apps that existed when the first page was requested. Apps created in the seconds before the first page was requested may be missing. Cursors expire 30 minutes after the first page was requested.

Response

OK

apps

object[]

Show child attributes

next_cursor

string

Pagination cursor for the next page. Absent when no more apps remain. Cursors expire 30 minutes after the first page was requested.

total_apps

integer

The number of apps matching the request, across all pages. When paginating, it is counted once when the first page is requested and not updated afterwards, so it may differ slightly from the number of apps returned: it excludes apps created later and includes apps deleted while paginating. Apps created in the seconds before the first page may also be counted but missing from the pages.

⌘I

List Apps

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

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

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

	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")

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

{
  "apps": [
    {
      "id": "<string>",
      "internal_numeric_id": 123,
      "machine_count": 123,
      "name": "<string>",
      "network": "<string>",
      "network_cidr": "<string>",
      "organization": {
        "internal_numeric_id": 123,
        "name": "<string>",
        "slug": "<string>"
      },
      "status": "<string>",
      "volume_count": 123
    }
  ],
  "next_cursor": "<string>",
  "total_apps": 123
}

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