Bandwidth

Get bandwidth time series

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

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

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "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
          }
        ]
      }
    ]
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisierung

X-API-KEYstringheadererforderlich
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Pfadparameter

idstring<uuid>erforderlich

Query-Parameter

startstring<date-time>
endstring<date-time>
step_secondsinteger<int32>
Grenzen:x >= 60

Antwort

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject