Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

SDK Function

RemoteBandwidthSnapshot.list()

Return Object

ListIterator<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 com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.RemoteBandwidthSnapshot;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<RemoteBandwidthSnapshot> remoteBandwidthSnapshots = RemoteBandwidthSnapshot.list(parameters);
  for (RemoteBandwidthSnapshot remoteBandwidthSnapshot : remoteBandwidthSnapshots.listAutoPaging()) {
    // Operate on remoteBandwidthSnapshot
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The RemoteBandwidthSnapshot Object

Some of the functions 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