Read organization usage - Fly.io

GET

/

v1

/

usage

Read organization usage

curl --request GET \
  --url https://api.sprites.dev/v1/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

}

require 'uri'
require 'net/http'

url = URI("https://api.sprites.dev/v1/usage")

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

{
  "end": "2023-11-07T05:31:56Z",
  "interval": "<string>",
  "partial": true,
  "start": "2023-11-07T05:31:56Z",
  "usage": [
    {
      "cpu_time_sec": 123.45,
      "end": "2023-11-07T05:31:56Z",
      "last_recorded_at": "2023-11-07T05:31:56Z",
      "reserved_memory_byte_sec": 3865470566400,
      "start": "2023-11-07T05:31:56Z",
      "sprite_ref": "default/demo"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start

string<date-time>

required

Inclusive start time in ISO8601 format.

Example:

"2026-10-01T00:00:00Z"

end

string<date-time>

Exclusive end time in ISO8601 format. Defaults to now.

Example:

"2026-10-02T00:00:00Z"

interval

string

Bucket duration, such as 1h, or auto. Minimum 1s. Omit for a single total.

Example:

"1h"

group_by

string

Set to sprite for a per-sprite breakdown. Defaults to organization totals.

Example:

"sprite"

cluster_id

string

Limit totals or the sprite breakdown to this cluster. Omit for all clusters.

Example:

"default"

Response

Success

Recorded provider usage in time buckets

end

string<date-time>

required

Exclusive end in UTC.

interval

string | null

required

Resolved bucket duration, or null when interval is omitted.

partial

boolean

required

True when missing minute records were detected. Returned totals include available records only and may understate usage. False means no gaps were detected, not proof of complete collection.

start

string<date-time>

required

Inclusive start in UTC.

usage

object[]

required

Available usage ordered by start time and sprite. Missing records contribute zero to these sums. Check partial before treating them as complete totals.

Show child attributes

⌘I

Read organization usage

curl --request GET \
  --url https://api.sprites.dev/v1/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

}

require 'uri'
require 'net/http'

url = URI("https://api.sprites.dev/v1/usage")

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

{
  "end": "2023-11-07T05:31:56Z",
  "interval": "<string>",
  "partial": true,
  "start": "2023-11-07T05:31:56Z",
  "usage": [
    {
      "cpu_time_sec": 123.45,
      "end": "2023-11-07T05:31:56Z",
      "last_recorded_at": "2023-11-07T05:31:56Z",
      "reserved_memory_byte_sec": 3865470566400,
      "start": "2023-11-07T05:31:56Z",
      "sprite_ref": "default/demo"
    }
  ]
}