Home
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.
REST API
Managing large amounts of information by using the application user interface can be time-consuming. You can use the REST APIs as an alternative to the graphical user interface to reduce the time that is needed to manage your software inventory and the content of your software catalog.
Core APIs
Core APIs include all primary set of APIs that are integrated with BigFix Inventory.
REST API for retrieving software inventory and metric utilization and classifying software (v2)
Available from 9.2.8. You can use REST API requests to quickly retrieve large amounts of data related to license metric utilization as well as your software inventory, including historical data about uninstalled software. You can then pass this data to other applications for further processing and analysis.

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.
- REST API
  Managing large amounts of information by using the application user interface can be time-consuming. You can use the REST APIs as an alternative to the graphical user interface to reduce the time that is needed to manage your software inventory and the content of your software catalog.
  - Software Products and Software Components
    BigFix Inventory detects software components which are bundled with the product.
  - REST API resources and HTTP methods
    The operations of the BigFix Inventory REST API protocol are defined as HTTP methods on certain REST resources.
  - Common REST API elements
    You use connectors and operators to build query segments that filter on matching conditions and values.
  - Mapping REST API versions
    Available from 9.2.8. For some REST APIs, version 2 is created to provide improved functions or experience. In such cases, the original API becomes deprecated with time and only version 2 is further developed. If you have custom tools or internal processes that are based on such REST APIs, it is best to adjust the tools to use the new version of the APIs.
  - REST API for retrieving authentication token
    You use the POST operation on the api/get_token element to request your unique token that is required to authenticate the REST API requests.
  - REST API for retrieving the BigFix Inventory version
    You use the GET operation on the api/sam/about element to request information about the version of BigFix Inventory.
  - Core APIs
    Core APIs include all primary set of APIs that are integrated with BigFix Inventory.
    - REST API for hardware (v2)
      Available from 9.2.8. You can use REST API requests to quickly retrieve large amounts of data related to hardware inventory, including historical data about removed computers. You can then pass this data to other applications for further processing and analysis.
    - REST API for retrieving software inventory and metric utilization and classifying software (v2)
      Available from 9.2.8. You can use REST API requests to quickly retrieve large amounts of data related to license metric utilization as well as your software inventory, including historical data about uninstalled software. You can then pass this data to other applications for further processing and analysis.
      - Retrieval of software inventory (v2)
        Available from 9.2.8. You use the GET operation on the api/sam/v2/software_instances element to request information about software installed in your infrastructure. The API returns details of existing components as well as historical data about components that were removed.
      - Classifying software (v2)
        Available from 9.2.14. You can use the PUT operation on the api/sam/v2/software_instances element to define, change, or migrate software classification.
      - Retrieval of software components (v2)
        Available from 9.2.14. You use the GET operation on the api/sam/v2/software_components element to request information about software components in your catalog. The API returns details of existing components as well as historical data about components that were removed.
      - Retrieval of license metric utilization (v2)
        Available from 9.2.10. Use the GET operation on the api/sam/v2/license_usage element to request information about utilization of license metrics by products that are installed in your infrastructure. By default, the results are returned for the computer group of the user whose token is used for authentication and cover the period for which data is aggregated in this group. They also include custom fields that were added to the All Metrics report.
      - Setting license metric thresholds and custom field values (v2)
        Available from 9.2.10. You use the PUT operation on the api/sam/v2/license_usage element to set up license metric thresholds as well as values of custom fields that were added on the All Metrics report.
      - Metric IDs and code names
        Available from 9.2.8. The api/sam/v2/software_instances and api/sam/v2/license_usage REST APIs return information about metric that is used by a product in the form of a unique metric ID or metric code name. Learn what is the relation between the metric ID and code name as well as what is the description of every metric.
    - REST API associations
      Available from 9.2.8. For REST APIs in version 2, you can use associations to retrieve additional data as part of API requests. For example, you can retrieve detailed information about computer hardware as part of the software_instances API request.
    - REST API for retrieving raw scan results
      Available from 9.2.2. Retrieving raw scan results through REST API is intended to improve the monitoring of your environment by allowing you to quickly discover software that was installed or modified recently. By using shortened data imports, data about your software reaches the server much quicker, and at the same time allows you to increase the number of imports that you can run each day.
    - Retrieving unified view
      Unified view APIs provides you a unified view of the instances.
  - Configuration APIs
    Configuration APIs include all APIs that you need to configure the application.
  - Historical APIs
    For some REST APIs, version 2 is created to provide improved functions or experience. In such cases, the original API is deprecated and version 2 is supported. You must adjust your custom tools or internal processes to the new version of these APIs.

REST API for retrieving software inventory and metric utilization and classifying software (v2)

9.2.8 Available from 9.2.8. You can use REST API requests to quickly retrieve large amounts of data related to license metric utilization as well as your software inventory, including historical data about uninstalled software. You can then pass this data to other applications for further processing and analysis.