Integrating with REST API

External systems integration is one of the key features of BigFix Inventory. Business logic is enabled for integration and interfaces are provided for common integration points.

Restriction: The database cannot be modified. The data can be retrieved only through REST API, not directly from the database.


  • Although using single REST API requests to retrieve data only from a selected subset of computers does not greatly impact the performance of BigFix Inventory, this is not true when retrieving data in bulk for all your computer systems at the same time. To improve the performance of a REST API, retrieve the data in chunks. For more information, see: REST API considerations.
  • Do not use REST API during the import as you might encounter a problem with the database connection. If the problem occurs, wait until the import finishes and ensure that the BigFix Inventory server is up and running. Then, repeat the API call.

Using the token

To use REST API when you are not logged in to BigFix Inventory, you must provide the token parameter for each query. To check the token, log in to BigFix Inventory, hover over the User icon User icon, and click Profile. Then, click Show token.

The token parameter is not required when you are logged in to BigFix Inventory.