v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Agents

List agents

get/v1/agent

Query parameters

device_idstring

ID of a device

Example:d_0123456789ab

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

sort_by'id' | 'hostname' | 'name'

Sort by a specific field

sort_ascboolean

Sort in ascending order

client_idstring

ID of a client

Example:c_0123456789ab

paired_beforestring date-time

Filter agents to before a specific pairing timestamp (RFC3339 format)

paired_afterstring date-time

Filter agents to after a specific pairing timestamp (RFC3339 format)

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

Filter agents by type

Response

Example response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}