Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

SDK Method

RemoteBandwidthSnapshot.List();

Return Object

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

using FilesCom.Models;

try
{
    var remoteBandwidthSnapshotIterator = RemoteBandwidthSnapshot.List();
    foreach (RemoteBandwidthSnapshot remoteBandwidthSnapshot in remoteBandwidthSnapshotIterator.ListAutoPaging()) {
        // Operate on remoteBandwidthSnapshot
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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