Sign in

c6d6f57e6da8

latestSwagger 2.02026-08-1044314611.7 MB
remote_servers
Agent Nodes

List Files.com Agent nodes

List Files.com Agent nodes

get/remote_servers/{id}/agent_nodes

Path parameters

idinteger required

Remote Server ID.

Response

The RemoteServers object.

node_idstring

Stable Agent installation ID

namestring

Customer-configured Agent node name

hostnamestring

Hostname reported by the Agent

availability_role'primary' | 'auto' | 'standby'

Configured traffic preference

status'available' | 'unavailable'

Whether this node currently has an available Agent instance

is_defaultboolean

Whether this node is the current default route for new unscoped work

direct_transfer_availableboolean

Whether the proxy recently validated a direct connection to this Agent node. False means direct transfers are enabled but not currently available; null means disabled or unsupported.

last_seen_atstring date-time

Most recent successful node observation

Example response

{
  "node_id": "example",
  "name": "example",
  "hostname": "example",
  "availability_role": "example",
  "status": "example",
  "is_default": true,
  "direct_transfer_available": true,
  "last_seen_at": "2000-01-01T01:00:00Z",
  "instances": [
    {
      "instance_id": "example",
      "process_state": "example",
      "status": "example",
      "is_default": true,
      "agent_version": "example",
      "last_seen_at": "2000-01-01T01:00:00Z",
      "connections": [
        {
          "mode": "example",
          "status": "example",
          "last_seen_at": "2000-01-01T01:00:00Z"
        }
      ]
    }
  ]
}