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.
Configuration APIs
Configuration APIs include all APIs that you need to configure the application.
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.
Configuration of advanced server settings
Available from 9.2.3. You use the PUT operation on the api/sam/configs element to change the values of the BigFix Inventory server settings.

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.
    - 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.
      - Retrieval of the current values of advanced server settings
        Available from 9.2.3. You use the GET operation on the api/sam/configs element to request information about the current values of the BigFix Inventory server settings. The output is returned in the JSON format.
      - Configuration of advanced server settings
        Available from 9.2.3. You use the PUT operation on the api/sam/configs element to change the values of the BigFix Inventory server settings.
    - 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.

Configuration of advanced server settings

Available from 9.2.3. You use the PUT operation on the api/sam/configs element to change the values of the BigFix Inventory server settings.

An icon representing a user.

You must be an Administrator to perform this task.

Table 1. Operation descriptions
Operation details	Description
Operation	`PUT /api/sam/configs`
Purpose	Changes the current value of a server setting.
HTTP method	`PUT`
Resource URI	https://`server_host_name`:`port_number`/api/sam/configs
URL link relation	n/a
URL query parameters	For a list of query parameters, see: Query parameters.
Request headers	Header `Accept-Language` (optional) Values en-US (only English is supported) Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
Request payload	n/a
Request `Content-Type`	`application/x-www-form-urlencoded`
Response headers	Header `Content-Language` Values en-US, … Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
Response payload	n/a
Response `Content-Type`	n/a
Normal HTTP response codes	`204`
Error HTTP response codes	`400 - "Bad Request"` if the provided value is invalid. For example, it is out of range or has a wrong type. `404 - "Not Found"`

Query parameters

The following table presents query parameters that you can use for the configs element.

Table 2. Query parameters for changing current values of server settings
Parameter	Description	Required	Value
name	Specifies the parameter whose value is to be changed. For a complete list of possible values and their explanation, see: Advanced server settings.	Yes	Name of the parameter
token	A unique user authentication identifier.	Yes	Alphanumeric
value	Specifies the new value of the parameter.	Yes	Value that is within the range specific for the parameter.

Example HTTP conversation

Request

PUT http://localhost:9981/api/sam/configs
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623&name=
maxVMManagerInactivity&value=30