REST API resources and HTTP methods
The operations of the BigFix Inventory REST API protocol are defined as HTTP methods on certain REST resources.
| Target REST operation URI | HTTP methods | Purpose of the operation |
|---|---|---|
api/get_token |
POST |
Returns a unique token that is required to authenticate REST API requests. |
api/sam/about |
Returns the version of BigFix Inventory. | |
api/import_status.json |
GET |
Returns the current status of the data import. |
| Core API | ||
api/sam/v2/license_usage
|
GET |
Returns information about utilization of license metrics by products that are installed in your infrastructure. |
PUT |
Sets up license metric thresholds as well as values of custom fields that were added on the All Metrics report. | |
api/sam/v2/software_instances |
GET |
Returns information about software inventory in your infrastructure. |
api/sam/v2/computers |
GET |
Returns information about hardware inventory in your infrastructure. |
api/sam/v2/detailed_hw_ip_addresses |
GET |
Retrieves information related to IP addresses of computers in your infrastructure. |
api/sam/v2/detailed_hw_lpars |
GET |
Retrieves information related to the logical partition and its CPU resources. |
api/sam/v2/detailed_hw_memories |
GET |
Retrieves information related to information related to the system memory of the scanned system. |
api/sam/v2/detailed_hw_network_adapters |
GET |
Retrieves information related to information related to the type, model and MAC addresses of the network adapters. |
api/sam/v2/detailed_hw_operating_systems |
GET |
Retrieves information related to information related to the operating system on the scanned computer. |
api/sam/v2/detailed_hw_partitions |
GET |
Retrieves information related to information related to the file system that is mounted on a scanned system: Unix mount points and Windows logical drives. |
api/sam/v2/detailed_hw_physical_processors |
GET |
Retrieves information related to information related to all active physical processors. |
api/sam/v2/detailed_hw_smbios |
GET |
Retrieves information related to information related to SMBIOS of the scanned system. |
api/sam/v2/detailed_hw_storages |
GET |
Retrieves information related to information related to storage devices on the scanned system. |
api/sam/raw_app_usage_property_values |
GET |
Retrieves raw metering data. |
api/sam/raw_file_facts |
GET |
Retrieves raw scanned file data. |
api/sam/raw_package_facts |
GET |
Retrieves raw package data. |
api/sam/raw_unix_package_facts |
GET |
Retrieves raw UNIX package data. |
/api/sam/unified/current/software |
GET |
Provides unified view of the currently installed software instances and package data. |
| Configuration APIs | ||
/api/sam/v2/contracts.json |
GET |
Retrieves contract information. |
/api/sam/v2/contracts.json |
PUT |
Adds and updates contracts. |
api/sam/vmmanagers |
GET |
Returns information about VM managers that are defined in your infrastructure. |
PUT |
Adds or updates VM managers. | |
api/v1/servers |
PUT |
Changes Oracle core factor that is assigned to a server. |
sam/component_lifecycles |
POST |
Sets the end of support date for software components. |
sam/software_components/software_component_id/component_lifecycles
|
DELETE |
Removes the end of support date for a software component. |
sam/software_components/software_component_id/component_lifecycles
|
DELETE |
Removes the end of support date for a software component. |
api/reports/report_ID |
GET |
Exports a saved report view. |
api/reports |
POST |
Imports a saved report view. |
api/sam/configs |
GET |
Returns information about the current settings of the administration server. |
PUT |
Changes the current settings of the administration server. | |
api/sam/v2/metrics |
POST |
Creates and manages the products and metrices. |
GET
|
Returns the list of products and metrices. | |
PUT |
Updates the metrics for products. | |
DELETE |
Deletes metric for products. | |
| Historical APIs | ||
api/sam/clusters |
GET |
Returns information about clusters that group your host computer systems. |
api/sam/computer_systems |
GET |
Returns a list of computer systems in your infrastructure. |
api/sam/license_usages |
GET |
Returns information about license usage reported by your computer systems. |
api/sam/software_instances |
GET |
Returns a list of installed software instances. Note: This
REST API is now substituted with api/sam/v2/software_instances REST API.
|
api/sam/swinventory/confirm |
POST |
Confirms instances to bundle or assign. |
api/sam/swinventory/confirmRelease |
POST |
Confirms the assignment of instances for a release. |
api/sam/swinventory/exclude |
POST |
Excludes instances from pricing calculations. |
api/sam/swinventory/include |
POST |
Includes instances in pricing calculations. |
api/sam/swinventory/instanceToShare |
GET |
Returns a list of software releases that can share a particular instance. |
api/sam/swinventory/product/{product_id}/releases |
GET |
Returns a list of releases of a particular software product that is identified by its identifier. |
api/sam/swinventory/products |
GET |
Returns a list of software products. |
api/sam/swinventory/reassign |
POST |
Reassigns instances to a product. |
api/sam/swinventory/reassignRelease |
POST |
Reassigns instances to a product for a list of releases. |
api/sam/swinventory/release/{release_id}/instances |
GET |
Returns a list of instances for the requested software product release. |
api/sam/swinventory/share |
POST |
Shares an instance with a list of software products. |
api/sam/swinventory/targetBundlesOfInstances |
GET |
Returns a list of possible releases to which the requested software instance can be reassigned. |
api/sam/swinventory/targetBundlesOfReleases |
GET |
Returns a list of possible releases to which the instances of the requested software releases can be reassigned. |
api/sam/swinventory/targetInstances |
GET |
Returns a list of target instances that will be reassigned to a particular release. |