v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Bandwidth

Return bandwidth retention period

This function retrieves the retention periods for bandwidth data.

get/Bandwidth/get_retention_periods

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_retention_periods",
  "module": "Bandwidth",
  "result": {
    "data": [
      {
        "interval": "5min",
        "retention": 2678400
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}