Agent Push Updates

Push update to Files Agent

SDK Method

remote_server.agent_push_update

Return Object

AgentPushUpdate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a user with an Integration-Centric file system layout managing their own Remote Servers.

Example Request

begin
  remote_server = Files::RemoteServer.new
  remote_server.agent_push_update
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 AgentPushUpdate Object

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

AttributeDescription
version
string
Pushed agent version
message
string
Update accepted or reason
current_version
string
Installed agent version
pending_version
string
Pending agent version or null
last_error
string
Last error message or null
error
string
Error code