Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

SDK Method

Files::RemoteBandwidthSnapshot.list

Return Object

List<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

begin
  remote_bandwidth_snapshots = Files::RemoteBandwidthSnapshot.list
  remote_bandwidth_snapshots.auto_paging_each do |remote_bandwidth_snapshot|
    # Operate on remote_bandwidth_snapshot
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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