Skip to main content

FleetDM

Visualize your FleetDM policies, hosts, users, and installed software in the JupiterOne graph and detect policy violations with JupterOne Alerts.

Installation​

To use this integration, JupiterOne requires the credentials of a FleetDM API-only user with the global Admin role. The integration signs in with the user's email and password to obtain a bearer token, and it rejects any user that does not have the global admin role.

Creating an API-only user in FleetDM​

Using the fleetctl command line tool (installation instructions here), create an API-only user with the global admin role:

fleetctl user create --name "API User" --email api@example.com --password *** --api-only --global-role admin
note

A new API-only user defaults to the Observer role, so --global-role admin must be set explicitly. The integration will not run without the global admin role.

You can also create the API-only user from the Fleet UI: go to Settings → Users → Create user, select the API-only option, and assign the Admin global role.

note

If you use FleetDM to manage cloud hosts in addition to user endpoints, create a custom label that includes the user endpoints you want to ingest as Device entities. Each labeled host is ingested as a Device entity, and any host that is not labeled is ingested as a Host entity. If you do not manage cloud hosts and every host is a user endpoint, you do not need a custom label, and all hosts are ingested as Device entities.

Configuration in JupiterOne​

To install the FleetDM integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select FleetDM. Click New Instance to begin configuring your integration.

Creating an instance requires the following:

  • The Account Name used to identify the FleetDM account in JupiterOne. Ingested entities store this value in tag.AccountName when the AccountName toggle is enabled.

  • A Description to assist in identifying the integration instance, if desired.

  • A Polling Interval that is sufficient for your monitoring needs. You may leave this as DISABLED and run the integration manually.

  • Your FleetDM User Email — the email address of the FleetDM API-only admin user.

  • Your FleetDM User Password — the password for that FleetDM API-only admin user.

  • Your FleetDM Hostname — the hostname or URL of your FleetDM instance, for example mycompany.fleetdm.com or https://mycompany.fleetdm.com.

  • Optionally, User Endpoint Labels — FleetDM host labels that, when specified, cause the labeled hosts to be ingested as user endpoints and all other hosts to be ingested as hosts. If left empty, all hosts are ingested as user endpoints. Separate multiple labels with commas, for example macOS,MS Windows,Ubuntu Linux.

Click Create once all values are provided to finalize the integration.

Next steps​

Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data about your FleetDM environment within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.