Return bandwidth retention period

This function retrieves the retention periods for bandwidth data.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Bandwidth/get_retention_periods
Request samples
uapi --output=jsonpretty \
  --user=username \
  Bandwidth \
  get_retention_periods
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "get_retention_periods",
  • "module": "Bandwidth",
  • "result": {
    • "data": [
      • {
        • "interval": "5min",
        • "retention": 2678400
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}