Retrieving raw UNIX package data
Available from 9.2.2. This API retrieves raw UNIX package data, which contains information about all packages discovered on the UNIX operating systems. Unlike in the UI, through this API you can retrieve all historical data that is stored in the database.
To obtain information about detected software use api/sam/v2/software_instances
API.
Before you begin
Use limit parameter when previewing API output
When you use api/sam/raw_unix_package_facts
API for test purpose, append the
limit parameter to achieve faster response time. First 100 records should be sufficient to have
a view on the data available.
https://hostname:port/api/sam/raw_unix_package_facts?token=token&limit=100
Operation details | Description |
---|---|
Operation | GET /api/sam/raw_unix_package_facts |
Purpose | Returns raw scanned file data. |
HTTP method | GET |
Resource URI | https://server_host_name:port_number/api/sam/raw_unix_package_facts |
URL link relation | n/a |
URI query parameters | n/a |
Request headers |
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 |
|
Response headers |
Specifies the content type of the response. |
Specifies the language of the response content. If this header is not specified, the content is returned in the server language. |
|
Response payload | Unix Package Fact element |
Response Content-Type |
|
Normal HTTP response codes |
|
Error HTTP response codes |
Message body includes an error message with details. |
Available columns
Column | Description | Displayed by default | Type |
---|---|---|---|
is_suppressed | Indicates that package is suppressed. When the package is suppressed the column value is 1. When the package is not suppressed, the value is 0. | Boolean | |
comment | Comment about the suppression. | String | |
unix_package_property_id | Identifier of the unix package property. | ✓ | Numeric |
version_id | Internal version identifier of the package. | Numeric | |
type | Type of the package data. | ✓ | String |
index_sha1 | Package sha1 checksum | ✓ | String |
computer_id | Identifier of the computer as defined in BigFix Inventory. | ✓ | Numeric |
description | Description of the package. | ✓ | String |
name | Name of the package. | ✓ | String |
version | Version of the package. | ✓ | String |
vendor | Vendor of the package. | ✓ | String |
valid_from | Date and time when the package was reported for the first time. The time is specified in the GMT time zone. | ✓ | String |
valid_to | Date and time when the package was reported for the last time. The time is specified in the GMT time zone. | ✓ | String |
Query parameters
Parameter | Description | Required | Value |
---|---|---|---|
columns | Specify which columns to retrieve. If you do
not specify this parameter, a set of default columns is retrieved.
Example: Retrieve the name and computer_id columns:
|
No | String |
order | Specify how to sort the returned data. The default
direction for sorting columns is ascending. If you want to specify
a descending sort, append desc to the column name.
Example: Order by name descending:
|
No | String |
limit | Specify the number of rows to retrieve. If you omit this parameter, all rows
are retrieved. For BigFix Inventory
versions up to 10.0.1, if you omit the 'limit' parameter, 100 000 rows are retrieved. The
number is defined at raw_data_api_default_limit on the Advanced Server
Settings panel. Note: Parameter raw_data_api_default_limit has been
removed since BigFix Inventory
version 10.0.2. |
No | Numeric |
offset | Specify the number of rows to skip for retrieving
results. You can use it together with the limit parameter to paginate
results. Example: Retrieve 50 records starting after record 150:
|
No | Numeric |
token | A unique user authentication identifier. You can view your token in the Profile preferences of BigFix Inventory. | Yes | Alphanumeric |
criteria | Retrieve records which match specific
conditions. The parameter should have the following structure, written
on one line:
For more information about operators, see Common connectors and operators. Example: Retrieve UNIX package
data from computer systems with ID greater than 10:
For
columns that use the date and time values, such as Last Seen, you
can retrieve data also for a period instead of a specific date. To
do so, use last or next as <operator>,
and then specify the time value in the following convention: PxD/PxW/PxM/PxY,
where x is a number in the 1-999 range, and D, W, M, or Y is a designator
that represents days, weeks, months, or years respectively. For example,
to retrieve computer systems that reported within last 7 days, use
the following API request:
|
Example HTTP conversation
- Request
GET api/sam/raw_unix_package_facts ?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)
{ "unix_package_property_id": -1, "computer_id": 14, "name": "lohit-oriya-fonts", "version": "2.4.3-6.el6", "vendor": "Red Hat, Inc.", "description": null, "type": "Rpm", "index_sha1": "176d82d8994b5c7b27f5ba8446cb40a802b2e8f5", "valid_from": "2016-02-29T15:33:10Z", "valid_to": "9999-12-31T23:59:59Z" } { "unix_package_property_id": -1, "computer_id": 14, "name": "libcollection", "version": "0.6.0-9.el6", "vendor": "Red Hat, Inc.", "description": null, "type": "Rpm", "index_sha1": "69ac3e6fc5674c4feb1c90aae88975d9d0ebe615", "valid_from": "2016-02-29T15:33:10Z", "valid_to": "9999-12-31T23:59:59Z" }