Get Application Overview

Retrieves comprehensive status overview for an application including latency, CPU/RAM usage, active instances, regions, and cost information.

GET /apps/{appId}/overview

Get Application Overview

cURL

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

import requests

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

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}/overview', 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}/overview",
  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}/overview"

	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}/overview")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "targetLatency": {
    "indicator": 123
  },
  "currentLatency": {
    "indicator": 123
  },
  "activeRegions": {
    "indicator": 123
  },
  "activeInstances": {
    "indicator": 123
  },
  "desiredInstances": 123,
  "averageCPU": {
    "indicator": 123
  },
  "averageRAM": {
    "indicator": 123
  },
  "averageVolumesUsage": {
    "indicator": 123
  },
  "regions": [
    {
      "region": "<string>",
      "isRequired": true,
      "instances": 123,
      "averageCPU": 123,
      "averageRAM": 123,
      "averageVolumesUsagePercentage": 123,
      "requests": 123,
      "anycastTraffic": 123,
      "pods": [
        {
          "name": "<string>",
          "lastHeartBeat": "2023-11-07T05:31:56Z",
          "outboundTrafficChart": {},
          "cpuUsage": 123,
          "ramUsage": 123,
          "containers": [
            {
              "id": "<string>",
              "name": "<string>",
              "cpuUsage": 123,
              "ramUsage": 123,
              "reason": "<string>",
              "message": "<string>",
              "image": "<string>",
              "imageDisplay": "<string>",
              "numberOfRestarts": 123,
              "exitCode": 123
            }
          ],
          "message": "<string>",
          "volumesUtilizationPercentage": {},
          "ephemeralStorageUsageBytes": 123,
          "ephemeralStorageLimitBytes": 123,
          "ephemeralStorageUsageRatio": 123,
          "outboundConnectionsLimit": 123,
          "outboundConnectionsRejectedDiff": 123
        }
      ]
    }
  ],
  "averageLatency": 123,
  "totalVolumeSizeInGb": 123,
  "monthlyCost": 123,
  "latencyChart": {}
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "id": "<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

Application status overview was successfully retrieved.

Application overview model

targetLatency · object

Status grade model

Show child attributes

currentLatency · object

Status grade model

Show child attributes

activeRegions · object

Status grade model

Show child attributes

activeInstances · object

Status grade model

Show child attributes

desiredInstances · integer<int32>

status · enum<string>

Available options: unknown, active, progressing, inactive, failing, suspended

averageCPU · object

Status grade model

Show child attributes

averageRAM · object

Status grade model

Show child attributes

averageVolumesUsage · object

Status grade model

Show child attributes

regions · object[]

Show child attributes

averageLatency · number<double>

totalVolumeSizeInGb · number<double>

monthlyCost · number<double>

latencyChart · object

Show child attributes