Welcome
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.
Configuration APIs
Configuration APIs include all APIs that you need to configure the application.
REST API for managing VM managers
You can use REST API requests to add and change VM managers in your infrastructure.
Retrieval of VM manager Tools
Use the GET operation on the api/sam/v3/vmmanagertools endpoint to retrieve information about VM Manager Tools that are defined in your infrastructure. The REST API returns the list of all tools that were not deleted.

BigFix Documentation Homepage
BigFix 11 Inventory Documentation
Welcome to the BigFix Inventory documentation, where you can find information about how to install and configure BigFix Inventory. The application provides you with information about your inventory and license metrics. You can manage your software assets, gather information about your hardware, and ensure license compliance for your enterprise using BigFix Inventory.
BigFix Platform
BigFix Scanner (New)
Overview
Become familiar with key concepts that are necessary to understand how BigFix Inventory works and learn about features and functions that are introduced in every version of the application.
Installing
Learn about the requirements and available installation scenarios to ensure that the deployment of BigFix Inventory goes smoothly in your environment.
Configuring
After you install BigFix Inventory, configure the application. Create accounts for the users who need access to the application and set up scans to collect software and hardware inventory data from your environment.
Upgrading
A new version of BigFix Inventory is released periodically, typically at the end of each calendar quarter. Upgrade to the new version regularly to take full advantage of new features and application fixes.
Catalog Overview
This section provides information about catalog updates available with every release.
Managing the infrastructure
After you complete the initial configuration of BigFix Inventory, learn how to manage components of its infrastructure: VM managers, server, database, and data sources.
Software inventory and license utilization
You can classify the discovered software so that reports in BigFix Inventory reflect your entitlements and properly show utilization of license metrics by particular products.
Managing security threats
Learn how to use BigFix Inventory to manage security threats in your environment. You can view whether any of the installed components is prone to any Common Vulnerability and Exposure (CVE).
Tutorials
Tutorials help you understand how to use BigFix Inventory. They consist of modules that focus on broad goals. Modules consist of tasks that show how to configure specific settings step-by-step.
Security
Configure different security features to adequately protect business assets and resources in the data model when using BigFix Inventory.
Troubleshooting and support
Learn about solutions to common problems that might arise when you use BigFix Inventory BigFix Inventory and how to find logs and trace files that help you troubleshoot those problems.
Tuning performance
Learn how to plan the infrastructure of BigFix Inventory and to configure the application server to achieve optimal performance. The following guidelines are applicable in big data environments as well as in smaller environments that are running on low-performance hardware.
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.
  - Configuration APIs
    Configuration APIs include all APIs that you need to configure the application.
    - REST API for managing VM managers
      You can use REST API requests to add and change VM managers in your infrastructure.
      - Retrieval of VM managers
        Use the GET operation on the api/sam/vmmanagers element to retrieve information about VM managers that are defined in your infrastructure. The API returns the same data as available on the VM Managers panel. The VM Managers that do not report longer than the value allowed through maxVMManagerVisibility are not be returned by the API.
      - Retrieval of VM manager Tools
        Use the GET operation on the api/sam/v3/vmmanagertools endpoint to retrieve information about VM Manager Tools that are defined in your infrastructure. The REST API returns the list of all tools that were not deleted.
      - Adding and updating VM managers
        You use the PUT operation on the api/sam/vmmanagers element to add or update VM managers. For versions below 11.0.7, you can perform these actions only for VM managers that are managed in central mode. Since version 11.0.8, you can perform add and update actions for all VM Managers.
    - REST API for changing advanced server settings
      Available from 9.2.3. You can change the parameters of the BigFix Inventory server by using REST API.
    - REST API for setting and deleting the end of support date
      Available from 9.2.11. You can set and delete the end of support date for any software component by using REST API.
    - REST API for adding and removing tags
      Available from 9.2.14. You can add and remove tags for any software component by using REST API.
    - REST API for export and import of saved report views
      You can use REST API requests to export a saved report view from one instance of BigFix Inventory and import it to another instance of the application.
    - REST API for updating the Oracle core factor
      Available from 9.2.8. You use the PUT operation on the api/v1/servers element to change the processor core factor that is applied to a group of servers for the purpose of calculating utilization of the Oracle Processor Core metric.
    - REST API for managing license metrics
      Use REST API requests to retrieve, create, change, and delete license metrics. From version 10.0.5, you can also manage metrics through the UI. See also, managing license metrics through UI.
    - REST API for managing contracts
      With the /api/sam/v2/contracts.json API, you can import and export contract data with purchase information. This operation is used to automate integration with external purchase systems. You can also manage contracts using: contracts CSV import, user interface - All Contracts panel and deprecated contracts migration.
  - 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.
Glossary
Guide in PDF format
DataFlow ServiceNow Integration
Service Graph Connector Integration

Retrieval of VM manager Tools

Use the GET operation on the api/sam/v3/vmmanagertools endpoint to retrieve information about VM Manager Tools that are defined in your infrastructure. The REST API returns the list of all tools that were not deleted.

Permission required: To retrieve information about VM manager Tools, you must have the 'Manage VM Managers and Servers' permission and All Computers group assigned.

Table 1. Operation descriptions
Operation details	Description
Operation	`GET /api/sam/v3/vmmanagertools`
Purpose	Returns a list of VM Manager Tools.
HTTP method	`GET`
Resource URI	https://server_host_name:port_number/api/sam/v3/vmmanagertools?token=token
Request `Content-Type`	`application/json`
Response `Content-Type`	`application/json`
Normal HTTP response codes	`200 – OK`
Error HTTP response codes	`401 – "Unauthorized"` if provided token is not valid `403 – "Forbidden"` if the user does not have the Manage VM Managers and Servers permission or is not assigned All Computers group Message body includes an error message with details.

Table 2. Response attributes
Attributes	Possible values
`id`	ID of the VM Manager Tool
`remoteComputerId`	Data Source computer ID of the endpoint where VM Manager Tool is installed.
`computerId`	Computer ID of the endpoint where VM Manager Tool is installed.
`version`	Version of the VM Manager Tool. This attribute is omitted when the tool version cannot be determined, which may occur if the VM Manager Tool was not installed through BigFix Inventory.
`installDate`	The date and time when the VM Manager Tool was installed.
`deleted`	Indicates whether the VM Manager Tool was removed from BigFix Inventory.

Example HTTP conversation

Request

GET http://localhost:9081/api/sam/v3/vmmanagertools
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

Response body (JSON)

[{
    "id":1,
    "remoteComputerId":3205710,
    "computerId":5,
    "version":"11.0.8.0",
    "installDate":"2025-11-01T12:30:00Z",
    "deleted":false
}]