Remote Bandwidth Snapshots

A RemoteBandwidthSnapshot is a remote bandwidth report for the given date.

List Remote Bandwidth Snapshots

SDK Method

files_sdk.remote_bandwidth_snapshot.list()

Return Object

ListObj[RemoteBandwidthSnapshot]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import files_sdk

try:
  remote_bandwidth_snapshots = files_sdk.remote_bandwidth_snapshot.list()
  for remote_bandwidth_snapshot in remote_bandwidth_snapshots.auto_paging_iter():
    # Operate on remote_bandwidth_snapshot
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The RemoteBandwidthSnapshot Object

Some of the methods above return a RemoteBandwidthSnapshot object. The attributes of this object are listed below.

AttributeDescription
id
int64		Site bandwidth ID
sync_bytes_received
int64		Site sync bandwidth report bytes received
sync_bytes_sent
int64		Site sync bandwidth report bytes sent
logged_at
date-time		Time the site bandwidth report was logged
remote_server_id
int64		ID of related Remote Server