Device API Overview

Device API Endpoints Overview

The Device API endpoints provide capabilities for managing device installers and device groups, enabling MSPs to organize and deploy their managed devices efficiently. These endpoints focus on device group management and installation deployment.

Key Features

Device Installation Management

  • Create and manage device installers
  • Configure installation parameters
  • Generate installation links and PIN numbers
  • Set maximum install limits and expiration dates

Device Group Organization

  • Create and manage logical device groups
  • Organize devices into hierarchical structures
  • Modify group configurations
  • Maintain group relationships

Available Endpoints

  • POST /device/installer\: Create new device installer with custom configuration
  • GET /device/group\: List all device groups and their hierarchy
  • POST /device/group\: Create a new device group
  • PUT /device/group/{groupId}\: Modify an existing device group
  • DELETE /device/group/{groupId}\: Remove a device group

Endpoint Details

Device Installer Creation

The device installer endpoint allows you to:

  • Specify device names and types
  • Associate with specific groups
  • Set customer information
  • Configure installation limits
  • Set link expiration dates
  • Generate unique installation identifiers

Key Parameters:

  • Device name and type
  • Group ID
  • Customer details (optional)
  • Installation limits
  • Expiration settings

Device Group Management

Device group endpoints enable you to:

  • List all existing device groups
  • Create new organizational groups
  • Modify group structures
  • Delete unused groups
  • Manage group hierarchies

Key Parameters:

  • Parent group ID
  • Group name
  • Group hierarchy settings