Skip to main content
GET
/
api
/
public
/
v1
/
bandwidth
Get bandwidth usage
curl --request GET \
  --url https://api.vmarea.com/api/v1/api/public/v1/bandwidth \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "vmId": "<string>",
      "vmName": "<string>",
      "status": "<string>",
      "nextRenewalAt": "2023-11-07T05:31:56Z",
      "throttled": true,
      "throttledAt": "2023-11-07T05:31:56Z",
      "usedBytes": "<unknown>",
      "packBytes": "<unknown>",
      "capBytes": null
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required