Snapshots

Snapshots allow you to create a read-only archive of files at a specific point in time. You can define a snapshot, add files to it, and then finalize it. Once finalized, the snapshot’s contents are immutable.

Each snapshot may have an expiration date. When the expiration date is reached, the snapshot is automatically deleted from the Files.com platform.

List Snapshots

SDK Method

Files::Snapshot.list

Return Object

List<Snapshot>

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

begin
  snapshots = Files::Snapshot.list
  snapshots.auto_paging_each do |snapshot|
    # Operate on 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

Show Snapshot

SDK Method

Files::Snapshot.find

Return Object

Snapshot

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Snapshot ID.

Example Request

begin
  snapshot = Files::Snapshot.find(id)
  # Operate on snapshot
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

Create Snapshot

SDK Method

Files::Snapshot.create

Return Object

Snapshot

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDefaultDescription
expires_at
string		When the snapshot expires.
name
string		A name for the snapshot.
paths
array(string)		An array of paths to add to the snapshot.
workspace_id
int64		0Workspace ID. 0 means the default workspace.

Example Request

begin
  snapshot = Files::Snapshot.create(
    expires_at: "2000-01-01T01:00:00Z"
  )
  # Operate on snapshot
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

Finalize Snapshot

SDK Method

snapshot.finalize

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  # Find the snapshot object by its id.
  snapshot = Files::Snapshot.find(id)
  snapshot.finalize
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

Update Snapshot

SDK Method

snapshot.update

Return Object

Snapshot

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
expires_at
string		When the snapshot expires.
name
string		A name for the snapshot.
paths
array(string)		An array of paths to add to the snapshot.

Example Request

begin
  # Find the snapshot object by its id.
  snapshot = Files::Snapshot.find(id)
  snapshot.update(
    expires_at: "2000-01-01T01:00:00Z"
  )
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

Delete Snapshot

SDK Method

snapshot.delete

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  # Find the snapshot object by its id.
  snapshot = Files::Snapshot.find(id)
  snapshot.delete
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 Snapshot Object

Some of the methods above return a Snapshot object. The attributes of this object are listed below.

AttributeDescription
id
int64		The snapshot's unique ID.
expires_at
date-time		When the snapshot expires.
finalized_at
date-time		When the snapshot was finalized.
name
string		A name for the snapshot.
user_id
int64		The user that created this snapshot, if applicable.
bundle_id
int64		The bundle using this snapshot, if applicable.
workspace_id
int64		Workspace ID. 0 means the default workspace.