AIaikido

List endpoint devices

Returns a list of all the endpoint protection devices

get/endpoint-protection/devices

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/endpoint-protection/devices
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: endpoint_protection:read

Response

A list of all the endpoint protection devices

idinteger

The ID of the device in Aikido

namestring

The name of the device

osstring

The operating system of the device

versionstring

The version of the Aikido endpoint protection software installed on the device

serial_numberstring nullable

The hardware serial number of the device, or null if it has not been reported yet

userstring

The user of the device

permission_group_idinteger

The ID of the permission group related to the device

permission_group_namestring

The name of the permission group related to the device

last_heartbeat_atinteger

The Unix timestamp of the last heartbeat of the device sent by the Aikido endpoint protection software

status'offline' | 'not_protected' | 'upgrade_needed' | 'protected'

The status of the device

Example response

[
  {
    "id": 1,
    "name": "Yuri's MacBook Pro",
    "os": "macos",
    "version": "1.0.0",
    "serial_number": "C02XL0GHJGH5",
    "user": "Yuri Dart",
    "permission_group_id": 1,
    "permission_group_name": "Default",
    "last_heartbeat_at": 1716854400,
    "status": "protected"
  },
  {
    "id": 2,
    "name": "Sugman's MacBook Pro",
    "os": "macos",
    "version": "1.0.3",
    "serial_number": null,
    "user": "Sugman Utz",
    "permission_group_id": 2,
    "permission_group_name": "Sales",
    "last_heartbeat_at": 1716854400,
    "status": "offline"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.