Skip to main content
GET
/
apps
/
{appId}
/
overview
Get Application Overview
curl --request GET \
  --url https://api.bunny.net/mc/apps/{appId}/overview \
  --header 'AccessKey: <api-key>'
{
  "targetLatency": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "currentLatency": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "activeRegions": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "activeInstances": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "desiredInstances": 123,
  "status": "Unknown",
  "averageCPU": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "averageRAM": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "averageVolumesUsage": {
    "indicator": 123,
    "statusGrade": "CouldBeBetter"
  },
  "regions": [
    {
      "region": "<string>",
      "isRequired": true,
      "instances": 123,
      "status": "Unknown",
      "averageCPU": 123,
      "averageRAM": 123,
      "averageVolumesUsagePercentage": 123,
      "requests": 123,
      "anycastTraffic": 123,
      "pods": [
        {
          "name": "<string>",
          "status": "NotScheduled",
          "lastHeartBeat": "2023-11-07T05:31:56Z",
          "outboundTrafficChart": {},
          "cpuUsage": 123,
          "ramUsage": 123,
          "containers": [
            {
              "id": "<string>",
              "name": "<string>",
              "cpuUsage": 123,
              "ramUsage": 123,
              "reason": "<string>",
              "message": "<string>",
              "status": "NotStarted",
              "image": "<string>",
              "imageDisplay": "<string>",
              "numberOfRestarts": 123
            }
          ],
          "message": "<string>",
          "volumesUtilizationPercentage": {}
        }
      ]
    }
  ],
  "averageLatency": 123,
  "totalVolumeSizeInGb": 123,
  "monthlyCost": 123,
  "latencyChart": {}
}

Authorizations

AccessKey
string
header
required

Please enter a valid personal API key.

Path Parameters

appId
string
required

Response

Application status overview was successfully retrieved.

Application overview model

targetLatency
object

Status grade model

currentLatency
object

Status grade model

activeRegions
object

Status grade model

activeInstances
object

Status grade model

desiredInstances
integer<int32>
status
enum<string>
Available options:
Unknown,
Active,
Progressing,
Inactive,
Failing,
Suspended
averageCPU
object

Status grade model

averageRAM
object

Status grade model

averageVolumesUsage
object

Status grade model

regions
object[]
averageLatency
number<double>
totalVolumeSizeInGb
number<double>
monthlyCost
number<double>
latencyChart
object