Back to top

How to use Knox Manage APIs to locate devices

Last updated October 16th, 2024

Categories:

Environment

  • Knox Manage

Overview

With Knox Manage APIs, you can get location information from your device fleet.

Prerequisites

You must set a location policy to allow for device location collection.

  1. In the Knox Manage console, click Profile.
  2. Click your desired profile and click Modify Policy.
  3. Under the Android Enterprise policy drawer, click Location.
  4. Set a policy to allow for location policy.
Policy Value
Location Settings

Choose one of the following:

  • Force on
  • Allow user to configure
  • Allow user to configure

If you select Allow user to configure or Allow user to configure and prompt for location accuracy, you must ensure the device user accepts and allow for location collection

Location Settings > Device Location Collection

Choose one of the following:

  • Automatic
  • Upon user consent

If you select Upon user consent, you must ensure the device user consents to automatic device location

Location Settings > Set Collection Time Any valid time value except "-"
  1. Click Save & Assign > OK to save and push your changes to the device fleet.

How to use Knox Manage APIs to locate devices

To use the Knox Manage API:

  1. Create an API client using Knox Manage.
  2. Generate the Authentication token.

Next, you can use the following commands to retrieve your device details:

You can now use any of the following commands to get information on the location of your devices:

Additional Reading

For more information about Knox Manage APIs, visit Manage API Clients.

Is this page helpful?