Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

Endpoint

GET/remote_bandwidth_snapshots

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

curl https://app.files.com/api/rest/v1/remote_bandwidth_snapshots.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "sync_bytes_received": 1,
    "sync_bytes_sent": 1,
    "logged_at": "2000-01-01T01:00:00Z",
    "remote_server_id": 1
  }
]

The RemoteBandwidthSnapshot Object

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

Example RemoteBandwidthSnapshot Object

{
  "id": 1,
  "sync_bytes_received": 1,
  "sync_bytes_sent": 1,
  "logged_at": "2000-01-01T01:00:00Z",
  "remote_server_id": 1
}