Installer

startInstallerLocateDevice

POST
/api/v1/installer/orgs/{org_id}/devices/{device_mac}/locate

Start locating an installer-managed device by blinking its LED. The locate state persists until Stop Locating Installer Device is called.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
device_mac*string
Match^[0-9a-fA-F]{12}$

Response Body

curl -X POST "https://example.com/api/v1/installer/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/0000000000ab/locate"
Empty