Agent Push Updates

Push update to Files Agent

Endpoint

POST/remote_servers/{id}/agent_push_update

Return Object

AgentPushUpdate

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required
Remote Server ID.

Example Request

curl https://app.files.com/api/rest/v1/remote_servers/{id}/agent_push_update.json \
  -X POST \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "version": "example",
  "message": "example",
  "current_version": "example",
  "pending_version": "example",
  "last_error": "example",
  "error": "example"
}

The AgentPushUpdate Object

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

Example AgentPushUpdate Object

{
  "version": "example",
  "message": "example",
  "current_version": "example",
  "pending_version": "example",
  "last_error": "example",
  "error": "example"
}