A Data Extract allows you to access data such as historical patching and API activity in a download file. This describes how you can view, generate, and download data extracts from the Automox console.
Viewing Data Extracts
You can view previously created data extracts from the Data Extracts page.
From the Reports page, click View for Data Extracts.
If any data extracts are available, you can click to download them. If no extracts are available, you can generate a new extract.
The Data Extracts table consists of the following columns:
Column name |
Description |
|---|---|
Data Requested |
Exact time and date when the extract was generated. |
Date Range |
Start and end dates of the requested extract. |
Extract Expiration |
Time and date the extract will no longer be available for download. After this date, the Status shows as expired. Note: Extracts are available for 24 hours. |
Type |
This shows which type of data extract was generated: Patch History or API Activity |
Status |
This can show the following statuses:
|
Note: The table can be sorted by Date Requested or Status.
Note: If you see a failed state, you can contact Automox Support by submitting a request through the customer portal. Provide the Data Extract ID so that we can help diagnose what went wrong.
Generating Data Extracts
You can generate an extract that provides details about patch activity or API activity for a defined time period.
From the Reports page, click View for Data Extracts.
Click Generate New.
Select the Extract Type you want to generate: Patch History or API Activity.
Enter the start date and end date for the extract you want to generate. You can generate an extract that is a maximum of 90 days. This represents the 90-day time frame leading up to the day before the extract is issued. For example, on 2020-12-01 the default time-frame start should be 2020-09-02 and it should end with 2020-11-30.
Click Generate.
Note: This process can take several minutes.You can view the process and status of the new extract on the Data Extracts page.
Downloading Data Extracts
You can download and save data extracts that you have created.
Note: Extracts are only available to be downloaded for 24 hours after being created.
From the Reports page, click View for Data Extracts.
On the Data Extracts page, find the extract you want to view and click Download.
The extract (CSV) includes the following information for the time frame requested, depending on which type of extract:
What is in the download for each extract type?
Patch History
Data Type |
Exported Column Name |
Meaning |
Description |
|---|---|---|---|
Device information |
device_name |
Device Name |
Name of device (typically hostname) |
device_custom_name |
Device Custom Name |
Name assigned to the device by the customer. |
|
organization_id |
Zone ID |
This is the zone ID |
|
device_id |
Device ID |
This number is the same as the server ID |
|
agent_version |
Agent Version |
Version of the Automox agent installed on the device |
|
group |
Group |
Name of the group this device is assigned to |
|
package_id |
Package ID |
Identifier for the specific package |
|
device_ignored |
Device Ignored |
This indicates if a software package is ignored for a device (from the Device Details) |
|
group_ignored |
Group Ignored |
This indicates if a software package is ignored globally from the Software page |
|
Patch Information |
patch_name |
Patch Name |
Name of the software update (patch) |
patch_version |
Patch Version |
Version number of the software update |
|
patch_knowledge_base |
Patch Knowledge Base |
Knowledge base identifier associated with the update |
|
Mutual Device/Patch Information |
operating_system_family |
Operating System Family |
OS family (Windows, Mac, or Linux) |
operating_system_name |
Operating System Name |
OS name of the installed system |
|
operating_system_version |
Operating System Version |
Installed OS version |
|
managed_patch |
Managed Patch |
This shows if the update is managed by Automox |
|
Event Data |
event_timestamp |
Event Timestamp |
Timestamp of the event |
patch_action |
Event Type (patch action) |
"Patch available" or "Patch installed" |
|
patch_available_timestamp |
Patch Available Timestamp |
Timestamp that informs when patch became available for installation |
|
patch_installed_timestamp |
Patch Installed Timestamp |
Timestamp that informs when patch was installed on the device |
|
exposure_time_hours |
Exposure Time |
Amount of time the device was not updated with the available patch |
|
Vulnerability Data |
patch_severity |
Patch Severity |
Severity (if any) of vulnerability associated with the patch (for example: critical, high, medium, low) |
cves |
CVEs |
CVEs (if any) associated with the patch |
API Activity
The CSV download includes the following exported data.
Column Name |
Description |
|---|---|
UUID |
Universally unique identifier for the log entry |
created_at (Creation Time) |
Time and date that the extract was created |
created_by (Created By) |
Automox service that handled the request |
environment |
Automox environment the activity was logged in |
organization_id |
ID of the zone |
user_id |
ID of the user who made the request |
identity_id |
The ID of the identity used to make the request. For users, this is identical to the User ID field. For API keys, this is the ID of the API key used to make the request. |
identity_type |
The type of identity used to make the request (api-key, user) |
request_id |
Unique identifier for the request |
method |
HTTP method |
path |
URL path (for example: /api/servers) |
content_type |
Content-type header, if present |
remote_ip |
IP of the remote client who made the request |
server_ip |
IP of the server that handled the request |
referer |
HTTP referer, if present |
query |
HTTP query string |
request_body |
HTTP request body |
response_code |
HTTP response code |
files |
An array of the file ref objects that were uploaded in the request. Each file ref has the following fields:
|
If you have questions about this, you can submit a request in our customer portal.