v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Agents

Get agent

get/v1/agent/{agent_id}

Path parameters

agent_idstring required

ID of an agent

Example:a_0123456789ab

Response

agent_idstring required

ID of an agent

agent_type'windows' | 'linux' | 'nas'

Type of agent. Possible values are "windows", "linux", "nas". May be empty for legacy agents.

agent_versionstring required

Version of the agent

backup_paused_indefiniteboolean

Whether backups are paused indefinitely. When true, backups remain paused regardless of backup_paused_until and will not resume until explicitly set via backup_resume.

backup_paused_untilstring date-time

Timestamp when backups will resume (RFC3339 format). If backup_paused_indefinite is also true, backups remain paused regardless of this timestamp until explicitly resumed via backup_resume.

backup_resumeboolean

Set to true to immediately resume backups. This clears both backup_paused_until and backup_paused_indefinite, and takes precedence over both if provided in the same request.

backup_schedule_activeboolean

Whether the backup schedule is active or paused. (for responses only)

booted_atstring date-time

Boot timestamp

client_idstring

ID of a client

commentsstring required

Comments about the agent

device_idstring required

ID of a device

display_namestring required

Customizable display name

encryption_algorithmstring

Storage encryption algorithm of the agent

file_index_enabledboolean required

Whether the file index is enabled

firmware_typestring required

Firmware type of the agent

hostnamestring required

Hostname of the system

ip_addressesstring[] required

This field is deprecated and will be removed in the future.

last_seen_atstring date-time required

Last seen timestamp

manufacturerstring

Manufacturer of the agent

nas_smb_usernamestring

SMB username for the NAS share. Only present for NAS agents.

nas_unc_pathstring

UNC path to the NAS SMB share. Only present for NAS agents.

osstring required

OS of the agent

os_versionstring required

OS version of the agent

platformstring required

OS platform of the agent

public_ip_addressstring ipv4 required

Public IP address of the agent

sealedboolean required

Whether the agent's encryption key is unloaded and unavailable for backups.

timezonestring required

Timezone of the agent

volumes_include_defaultboolean required

Whether the default volume is included in the backup

Example response

{
  "addresses": [
    {
      "ips": [
        "192.168.1.104"
      ],
      "mac": "62:bb:d3:0d:db:7d"
    }
  ],
  "agent_id": "a_0123456789ab",
  "agent_type": "windows",
  "agent_version": "1.2.3",
  "alert_configs": [
    {
      "alert_resume": true,
      "alert_type": "agent_backup_failed",
      "pause_for_minutes": 1440,
      "paused_until": "2025-10-31T23:59:59Z"
    }
  ],
  "backup_paused_indefinite": true,
  "backup_paused_until": "2025-10-31T23:59:59Z",
  "backup_resume": true,
  "backup_schedule": {
    "days": [
      0,
      1,
      2,
      3,
      4,
      5,
      6
    ],
    "end_hour": 18,
    "interval_in_minutes": 60,
    "start_hour": 9
  },
  "backup_schedule_active": true,
  "booted_at": "2024-08-23T01:25:08Z",
  "client_id": "c_0123456789ab",
  "comments": "This is a test agent",
  "default_restore_settings": {
    "cpu_count": 4,
    "disk_bus": "virtio",
    "memory_mb": 8192,
    "network_model": "virtio"
  },
  "device_id": "d_0123456789ab",
  "display_name": "My First Device",
  "encryption_algorithm": "aes-256-gcm",
  "file_index_enabled": true,
  "firmware_type": "UEFI",
  "hostname": "my-hostname-1",
  "ip_addresses": [
    "192.168.3.53"
  ],
  "last_seen_at": "2024-08-23T01:25:08Z",
  "local_retention_policy": {
    "retention_policy_max_age_months": 84,
    "retention_policy_name": "balanced"
  },
  "manufacturer": "Microsoft Corporation",
  "nas_smb_username": "backupuser",
  "nas_unc_path": "\\\\nas01\\backups",
  "os": "windows",
  "os_version": "10.0.19042",
  "passphrases": [
    {
      "agent_passphrase_id": "ape_0123456789ab"
    }
  ],
  "platform": "Microsoft Windows 10 Home",
  "public_ip_address": "74.83.124.111",
  "timezone": "America/New_York",
  "volumes": [
    {
      "include": true,
      "mount_points": [
        "C:"
      ],
      "volume_id": "v_0123456789ab"
    }
  ],
  "volumes_include_default": true,
  "vss_writer_configs": [
    {
      "excluded": true,
      "writer_id": "{76fe1ac4-15f7-4bcd-987e-8e1acb462fb7}",
      "writer_name": "Microsoft Exchange Writer"
    },
    {
      "excluded": false,
      "writer_id": "{A6AD56C2-B509-4E6C-BB19-49D8F43532F0}",
      "writer_name": "WMI Writer"
    }
  ]
}