Bandwidth

Get bandwidth time series

GET/v1/baremetal/{id}/bandwidth/stats

Gets the service's bandwidth rate series for the requested window, which defaults to the last 24 hours and starts no earlier than the service's creation.

curl --request GET \
  --url https://api.serverside.com/v1/baremetal/{id}/bandwidth/stats \
  --header 'Authorization: Bearer <api-key>'

{
  "success": true,
  "data": {
    "start": "2026-01-15T09:30:00Z",
    "end": "2026-01-15T09:30:00Z",
    "stepSeconds": 123,
    "total": {
      "points": [
        {
          "timestamp": "2026-01-15T09:30:00Z",
          "ingressBps": 123,
          "egressBps": 123
        }
      ]
    },
    "interfaces": [
      {
        "interfaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "interfaceName": "<string>",
        "points": [
          {
            "timestamp": "2026-01-15T09:30:00Z",
            "ingressBps": 123,
            "egressBps": 123
          }
        ]
      }
    ]
  }
}

Authorizations

Authorizationstringheaderrequired
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Required permission: organization.baremetal.read

Path parameters

idstring<uuid>required

Query parameters

startstring<date-time>
endstring<date-time>
stepSecondsinteger<int32>
Limits:x >= 60

Response

200 · application/json

OK

successbooleanrequired
Allowed values:true
dataobject | nullrequired