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

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": {}
}

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