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.
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.

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.
  - 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 the BigFix Inventory version

You use the GET operation on the api/sam/about element to request information about the version of BigFix Inventory.

To retrieve information about the current version of BigFix Inventory, use the following URL:

https://hostname:port/api/sam/about?token=token

Important:

To use this API, you must be assigned to the All Computers group and have the View Hardware Inventory permission.
Each API request must be authenticated with the token parameter. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon , and click Profile. Then, click Show token.
By default, the retrieved data is sorted by id.

Table 1. Operation descriptions
Operation details	Description
Operation	`GET /api/sam/about`
Purpose	Returns the version of BigFix Inventory
HTTP method	`GET`
Resource URI	https://`server_host_name`:`port_number`/api/sam/about
URL link relation	n/a
URI query parameters	n/a
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/json`
Response headers	Header `Content-Type` Values `application/json` Specifies the content type of the response.
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	`About` element
Response `Content-Type`	`application/json`
Normal HTTP response codes	`200 – OK`
Error HTTP response codes	`500 – “Bad Request”` if a query parameter contains errors or is missing Message body includes an error message with details.

Example HTTP conversation

Request

GET api/sam/about
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

Response header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US

Response body (JSON)

{
"product": "BigFix Inventory",
"version": "9.2.20140331-2015"
}