Malwarebytes Assets API
The Assets API from Malwarebytes — 8 operation(s) for assets.
OpenAPI Specification
openapi: 3.2.0
info:
title: Malwarebytes Assets API
version: 1.0.0
description: 'Operations tagged Assets across 2 of this provider''s published API definitions: malwarebytes-threatdown-nebula-openapi.json, malwarebytes-threatdown-oneview-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.threatdown.com
tags:
- name: Assets
paths:
/nebula/v1/assets/software/export:
servers:
- url: https://api.threatdown.com
post:
description: "Export assets software data. You can export across multiple accounts. Specify your interested fields and the output format.\n\nSupported output formats: csv, xlsx, json.\n\n## Settings\n\n| Name | Description |\n|------|-------------|\n| groups | List of queries. The constraints accepted are the same accepted by the search assets software route. Refer to [Search assets software API](#operation/api.nebula.search.assets.software) for more information about the constraints accepted. |\n| download | If set to true, the server will set the `Content-Disposition` header using the `filename` and `format` |\n| select | Which fields to select, and which field name to map to. See request schema for allowed values |\n| type | Output encoding (for `csv` and `json` format) |\n| filename | Name of the file to be set in `Content-Disposition` header if `download` = true |\n\n## Examples\n\n### Download HTML file\n\nA request with this body sent by a browser will download a file called `nameofthefile.html`, displaying a table with columns: `Path`, `Name`, `Machine ID`, `Machine Name` for all detections on `windows` endpoints within account id `1e14cd0a-2ef3-4db3-b8a4-c89894d9aa34`:\n\n```json\n\t{\n\t\t\"groups\": [{\n\t\t\t\"vendor\": \"Mozilla\"\n\t\t}],\n\t\t\"format\": \"html\",\n\t\t\"type\": \"string\",\n\t\t\"filename\": \"nameofthefile\",\n\t\t\"download\": true,\n\t\t\"select\": [\n {\"field\": \"accountId\", \"newField\": \"account_id\"},\n {\"field\": \"groupId\", \"newField\": \"groupId\"},\n {\"field\": \"vendor\", \"newField\": \"vendor\"},\n {\"field\": \"product\", \"newField\": \"product\"},\n {\"field\": \"installationDate\", \"newField\": \"installationDate\"},\n {\"field\": \"createdAt\", \"newField\": \"createdAt\"}\n ]\n\t}\n```\n\n### Download xlsx file\n\nA request with this body sent by a browser will download a file called `report.html`, displaying a table with columns: `Path`, `Name`, `Machine ID`, `Machine Name` for all `windows` endpoints within account id `1e14cd0a-2ef3-4db3-b8a4-c89894d9aa34` and the endpoint with id `211a4cfc-557e-4ba7-a96f-70685a07c29e`:\n\n```json\n\t{\n\t\t\"groups\": [{\n \t\"vendor\": \"Mozilla\"\n }],\n\t\t\"populate\": { \"account\": true, \"last_job\": true },\n\t\t\"format\": \"xlsx\",\n\t\t\"type\": \"base64\",\n\t\t\"filename\": \"report\",\n\t\t\"download\": true,\n\t\t\"select\": [\n {\"field\": \"accountId\", \"newField\": \"account_id\"},\n {\"field\": \"groupId\", \"newField\": \"groupId\"},\n {\"field\": \"vendor\", \"newField\": \"vendor\"},\n {\"field\": \"product\", \"newField\": \"product\"},\n {\"field\": \"installationDate\", \"newField\": \"installationDate\"},\n {\"field\": \"createdAt\", \"newField\": \"createdAt\"}\n ]\n\t}\n```\n\n\n"
summary: Export assets software
security:
- client_credentials:
- execute
- user_permissions:
- softwareInventory.view
status:
outage:
- auth
- search_stateless
parameters:
- name: authorization
required: true
in: header
description: Authorization token
schema:
type: string
- name: accountid
required: true
in: header
description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
schema:
type: string
pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
requestBody:
content:
application/json:
schema:
type: object
title: Export request
required:
- groups
- select
- format
properties:
format:
type: string
title: The output file
enum:
- csv
- xlsx
- html
- ods
- txt
- rtf
- json
download:
type: boolean
title: Whether to instruct the client to download the response as a file. Only clients like browsers are supported
type:
type: string
title: The encoding of the output
enum:
- string
- base64
- binary
default: string
select:
type: array
title: Which fields to select from the response
items:
type: object
title: Field
required:
- field
- newField
properties:
newField:
type: string
title: the new value
field:
type: string
title: The response field to map to a new value
enum:
- account_id
- parent_account_id
- group_id
- root_group_id
- group_name
- machine_id
- vendor
- normalized_vendor
- display_vendor
- product
- normalized_product
- display_product
- installed_version
- normalized_installed_version
- display_installed_version
- installation_date
- account_name
- host_name
- fully_qualified_host_name
- domain_name
- alias
- created_at
- os_info.os_type
- os_info.os_version
- os_info.os_platform
- os_info.os_architecture
- os_info.os_release_name
- object_guid
- latest_version_available
- cves
- cves_by_status.unknown
- cves_by_status.low
- cves_by_status.medium
- cves_by_status.high
- cves_by_status.critical
- cves_score
- cves_count
- cves_count_by_status.unknown
- cves_count_by_status.low
- cves_count_by_status.medium
- cves_count_by_status.high
- cves_count_by_status.critical
- language
- architecture
- product_signature
- categories
- supports_update
- supports_uninstall
- update_available
- ignored_until
- ignore_rule_ids
- active_directory.user.display_name
- active_directory.user.sam_account_name
- active_directory.user.ou
- active_directory.machine.display_name
- active_directory.machine.sam_account_name
- active_directory.machine.ou
groups:
type: array
title: List of queries
items:
type: object
title: Query to fetch endpoints
allOf:
- type: object
title: Search assets software request. Leading wildcards are not supported for constraint fields without '.keyword' suffix.
properties:
parent_account_id:
type: string
title: Filter the search by parent_account_id. Search for an exact match
not.parent_account_id:
type: string
title: Filter the search by parent_account_id. Search for the matches that are not equal to the value
group_id:
type: string
title: Filter the search by group_id. Search for an exact match
not.group_id:
type: string
title: Filter the search by group_id. Search for the matches that are not equal to the value
root_group_id:
type: string
title: Filter the search by root_group_id. Search for an exact match
not.root_group_id:
type: string
title: Filter the search by root_group_id. Search for the matches that are not equal to the value
machine_id:
type: string
title: Filter the search by machine_id. Search for an exact match
not.machine_id:
type: string
title: Filter the search by machine_id. Search for the matches that are not equal to the value
account_name:
type: string
title: Filter the search by account_name. Search for the matches that contain the value
account_name.keyword:
type: string
title: Filter the search by account_name. Search for an exact match
not.account_name:
type: string
title: Filter the search by account_name. Search for the matches that don't contain the value
not.account_name.keyword:
type: string
title: Filter the search by account_name. Search for the matches that are not equal to the value
host_name:
type: string
title: Filter the search by host_name. Search for the matches that contain the value
host_name.keyword:
type: string
title: Filter the search by host_name. Search for an exact match
not.host_name:
type: string
title: Filter the search by host_name. Search for the matches that don't contain the value
not.host_name.keyword:
type: string
title: Filter the search by host_name. Search for the matches that are not equal to the value
fully_qualified_host_name:
type: string
title: Filter the search by fully_qualified_host_name. Search for the matches that contain the value
fully_qualified_host_name.keyword:
type: string
title: Filter the search by fully_qualified_host_name. Search for an exact match
not.fully_qualified_host_name:
type: string
title: Filter the search by fully_qualified_host_name. Search for the matches that don't contain the value
not.fully_qualified_host_name.keyword:
type: string
title: Filter the search by fully_qualified_host_name. Search for the matches that are not equal to the value
domain_name:
type: string
title: Filter the search by domain_name. Search for an exact match
domain_name.keyword:
type: string
title: Filter the search by domain_name. Search for the matches that contain the value
not.domain_name:
type: string
title: Filter the search by domain_name. Search for the matches that are not equal to the value
not.domain_name.keyword:
type: string
title: Filter the search by domain_name. Search for the matches that do not contain the value
alias:
type: string
title: Filter the search by aliasn. Search for the matches that contain the value
alias.keyword:
type: string
title: Filter the search by aliasn. Search for an exact match
not.alias:
type: string
title: Filter the search by aliasn. Search for the matches that don't contain the value
not.alias.keyword:
type: string
title: Filter the search by aliasn. Search for the matches that are not equal to the value
vendor:
type: string
title: Filter the search by vendor. Search for the matches that contain the value
vendor.keyword:
type: string
title: Filter the search by vendor. Search for an exact match
not.vendor:
type: string
title: Filter the search by vendor. Search for the matches that don't contain the value
not.vendor.keyword:
type: string
title: Filter the search by vendor. Search for the matches that are not equal to the value
normalized_vendor:
type: string
title: Filter the search by normalized_vendor. Search for the matches that contain the value
normalized_vendor.keyword:
type: string
title: Filter the search by normalized_vendor. Search for an exact match
not.normalized_vendor:
type: string
title: Filter the search by normalized_vendor. Search for the matches that don't contain the value
not.normalized_vendor.keyword:
type: string
title: Filter the search by normalized_vendor. Search for the matches that are not equal to the value
display_vendor:
type: string
title: Filter the search by display_vendor. Search for the matches that contain the value
display_vendor.keyword:
type: string
title: Filter the search by display_vendor. Search for an exact match
not.display_vendor:
type: string
title: Filter the search by display_vendor. Search for the matches that don't contain the value
not.display_vendor.keyword:
type: string
title: Filter the search by display_vendor. Search for the matches that are not equal to the value
product:
type: string
title: Filter the search by product. Search for the matches that contain the value
product.keyword:
type: string
title: Filter the search by product. Search for an exact match
not.product:
type: string
title: Filter the search by product. Search for the matches that don't contain the value
not.product.keyword:
type: string
title: Filter the search by product. Search for the matches that are not equal to the value
normalized_product:
type: string
title: Filter the search by normalized_product. Search for the matches that contain the value
normalized_product.keyword:
type: string
title: Filter the search by normalized_product. Search for an exact match
not.normalized_product:
type: string
title: Filter the search by normalized_product. Search for the matches that don't contain the value
not.normalized_product.keyword:
type: string
title: Filter the search by normalized_product. Search for the matches that are not equal to the value
display_product:
type: string
title: Filter the search by display_product. Search for the matches that contain the value
display_product.keyword:
type: string
title: Filter the search by display_product. Search for an exact match
not.display_product:
type: string
title: Filter the search by display_product. Search for the matches that don't contain the value
not.display_product.keyword:
type: string
title: Filter the search by display_product. Search for the matches that are not equal to the value
installed_version:
type: string
title: Filter the search by installed_version. Search for the matches that contain the value
installed_version.keyword:
type: string
title: Filter the search by installed_version. Search for an exact match
not.installed_version:
type: string
title: Filter the search by installed_version. Search for the matches that don't contain the value
not.installed_version.keyword:
type: string
title: Filter the search by installed_version. Search for the matches that are not equal to the value
normaliazed_installed_version:
type: string
title: Filter the search by normalized_installed_version. Search for the matches that contain the value
normaliazed_installed_version.keyword:
type: string
title: Filter the search by normalized_installed_version. Search for an exact match
not.normaliazed_installed_version:
type: string
title: Filter the search by normalized_installed_version. Search for the matches that don't contain the value
not.normaliazed_installed_version.keyword:
type: string
title: Filter the search by normalized_installed_version. Search for the matches that are not equal to the value
display_installed_version:
type: string
title: Filter the search by display_installed_version. Search for the matches that contain the value
display_installed_version.keyword:
type: string
title: Filter the search by display_installed_version. Search for an exact match
not.display_installed_version:
type: string
title: Filter the search by display_installed_version. Search for the matches that don't contain the value
not.display_installed_version.keyword:
type: string
title: Filter the search by display_installed_version. Search for the matches that are not equal to the value
os_info.os_type:
type: string
title: Filter the search by os_info.os_type. Search for the matches that contain the value
os_info.os_type.keyword:
type: string
title: Filter the search by os_info.os_type. Search for an exact match
not.os_info.os_type:
type: string
title: Filter the search by os_info.os_type. Search for the matches that don't contain the value
not.os_info.os_type.keyword:
type: string
title: Filter the search by os_info.os_type. Search for the matches that are not equal to the value
os_info.os_version:
type: string
title: Filter the search by os_info.os_version. Search for the matches that contain the value
os_info.os_version.keyword:
type: string
title: Filter the search by os_info.os_version. Search for an exact match
not.os_info.os_version:
type: string
title: Filter the search by os_info.os_version. Search for the matches that don't contain the value
not.os_info.os_version.keyword:
type: string
title: Filter the search by os_info.os_version. Search for the matches that are not equal to the value
os_info.os_platform:
type: string
title: Filter the search by os_info.os_platform. Search for the matches that contain the value
os_info.os_platform.keyword:
type: string
title: Filter the search by os_info.os_platform. Search for an exact match
not.os_info.os_platform:
type: string
title: Filter the search by os_info.os_platform. Search for the matches that don't contain the value
not.os_info.os_platform.keyword:
type: string
title: Filter the search by os_info.os_platform. Search for the matches that are not equal to the value
os_info.os_platforms:
type: array
title: Filter the search by multiple os_info.os_platform. Search for exact matches
items:
type: string
os_info.os_architecture:
type: string
title: Filter the search by os_info.os_architecture. Search for the matches that contain the value
os_info.os_architecture.keyword:
type: string
title: Filter the search by os_info.os_architecture. Search for an exact match
not.os_info.os_architecture:
type: string
title: Filter the search by os_info.os_architecture. Search for the matches that don't contain the value
not.os_info.os_architecture.keyword:
type: string
title: Filter the search by os_info.os_architecture. Search for the matches that are not equal to the value
os_info.os_release_name:
type: string
title: Filter the search by os_info.os_release_name. Search for the matches that contain the value
os_info.os_release_name.keyword:
type: string
title: Filter the search by os_info.os_release_name. Search for an exact match
not.os_info.os_release_name:
type: string
title: Filter the search by os_info.os_release_name. Search for the matches that don't contain the value
not.os_info.os_release_name.keyword:
type: string
title: Filter the search by os_info.os_release_name. Search for the matches that are not equal to the value
installation_date_before:
type: string
format: date-time
title: Results include assets that have been created before the specified date
installation_date_after:
type: string
format: date-time
title: Results include assets that have been installed after the specified date
created_at_before:
type: string
format: date-time
title: Results include assets that have been created before the specified date
created_at_after:
type: string
format: date-time
title: Results include assets that have been installed after the specified date
name_multi_search:
type: string
title: Aliases for this machine
group_name:
type: string
title: Filter the search by group name. Search for the matches that contain the value
group_name.keyword:
type: string
title: Filter the search by group name. Search for an exact match
not.group_name:
type: string
title: Filter the search by group name. Search for the matches that don't contain the value
not.group_name.keyword:
type: string
title: Filter the search by group name. Search for the matches that are not equal to the value
object_guid:
type: string
title: Filter the search by object_guid. Search for the matches that contain the value
object_guid.keyword:
type: string
title: Filter the search by object_guid. Search for an exact match
not.object_guid:
type: string
title: Filter the search by object_guid. Search for the matches that don't contain the value
not.object_guid.keyword:
type: string
title: Filter the search by object_guid. Search for the matches that are not equal to the value
latest_version_available:
type: string
title: Filter the search by latest_version_available. Search for an exact match
latest_version_available.keyword:
type: string
title: Filter the search by latest_version_available.keyword. Search for the matches that contain the value
not.latest_version_available:
type: string
title: Filter the search by not.latest_version_available. Search for the matches that are not equal to the value
not.latest_version_available.keyword:
type: string
title: Filter the search by not.latest_version_available.keyword. Search for the matches that doesnt contain the value
cves:
type: array
items:
type: string
title: Filter the search by cves. Search for an exact match
cves.keyword:
type: array
items:
type: string
title: Filter the search by cves.keyword. Search for the matches that contain the value
not.cves:
type: array
items:
type: string
title: Filter the search by not.cves. Search for the matches that are not equal to the value
not.cves.keyword:
type: array
items:
type: string
title: Filter the search by not.cves.keyword. Search for the matches that doesnt contain the value
cves_by_status.unknown:
type: string
title: Filter the search by cves_by_status.unknown. Search for an exact match
cves_by_status.unknown.keyword:
type: string
title: Filter the search by cves_by_status.unknown.keyword. Search for the matches that contain the value
not.cves_by_status.unknown:
type: string
title: Filter the search by not.cves_by_status.unknown. Search for the matches that are not equal to the value
not.cves_by_status.unknown.keyword:
type: string
title: Filter the search by not.cves_by_status.unknown.keyword. Search for the matches that doesnt contain the value
cves_by_status.low:
type: string
title: Filter the search by cves_by_status.low. Search for an exact match
cves_by_status.low.keyword:
type: string
title: Filter the search by cves_by_status.low.keyword. Search for the matches that contain the value
not.cves_by_status.low:
type: string
title: Filter the search by not.cves_by_status.low. Search for the matches that are not equal to the value
not.cves_by_status.low.keyword:
type: string
title: Filter the search by not.cves_by_status.low.keyword. Search for the matches that doesnt contain the value
cves_by_status.medium:
type: string
title: Filter the search by cves_by_status.medium. Search for an exact match
cves_by_status.medium.keyword:
type: string
title: Filter the search by cves_by_status.medium.keyword. Search for the matches that contain the value
not.cves_by_statu
# --- truncated at 32 KB (496 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/malwarebytes/refs/heads/main/openapi/malwarebytes-assets-api-openapi.yml