Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

SDK Method

RemoteBandwidthSnapshot.list()

Return Object

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 RemoteBandwidthSnapshot from 'files.com/lib/models/RemoteBandwidthSnapshot';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const remoteBandwidthSnapshots = await RemoteBandwidthSnapshot.list();
  for (const remoteBandwidthSnapshot of remoteBandwidthSnapshots) {
    // Operate on remoteBandwidthSnapshot
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw 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