Malwarebytes Products API
The Products API from Malwarebytes — 3 operation(s) for products.
OpenAPI Specification
openapi: 3.2.0
info:
title: ThreatDown Products API
description: '# Introduction
ThreatDown Nebula API lets you remotely manage the security of your `Endpoints`, analyze their `assets`, perform advanced analysis on `Detections` of `Malware`, `Ransomware`, `Exploits` and other threats found by the `ThreatDown Endpoint Agent`, and issue jobs like `Scan`, `Isolate`, `Remediate` or `Reboot`.
To get started, you need a client credential pair (OAuth2 application). You can get a valid application through our sales team.
You can retrieve your `client_id` and `client_secret` credentials pair in your Nebula console by going to the Integrate page in Nebula. You must also know your Nebula `account_id`.
## Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).
This allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
## Authentication
ThreatDown API uses OAuth2, an open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications.
See the Authentication section for specific information about supported grants.
## Access'' scopes
When creating a new application, you can decide the level of access it has to your account''s data. This utility allows you to restrict the scope of access to your account''s data depending on the application''s needs. For example, if you only need to analyze detections found on your endpoint, the read scope will be enough to prevent that application from modifying data or issuing jobs.
Specifying access scopes gives you more control over the access of your data. For example, you may want your company''s IT department to be able to isolate infected endpoints, while you may want your analysts to only read data for generating reports. To do so, you can create two applications using different scopes, and provide the right people with the right pair of credentials for programmatic access.
## User permissions
The user associated with the client (i.e. the user that created the OAuth2 application) must have the required permissions to perform the requested operation. If the user does not have sufficient permissions, the API will respond with a `403 Forbidden` status code.
For each API, you can find the required permissions in the AUTHORIZATIONS dropdown, under `user_permissions`.
Some API requires additional permissions based on the data in the body:
- **jobs** issue API requires `<entity>.performActions` depending on the `command` (\<entity\> can be `endpoints`, `softwareInventory`, or `detections`)
- **notifications** create/update API requires `<entity>.view` depending on the `category`
- **reports** create/update API requires `<entity>.view` depending on the `type`
## Rate Limiting
ThreatDown API implements a rate-limiting mechanism to prevent abuse. The rate-limiting mechanism is implemented using a leaky bucket algorithm. Once you exceed the available limit, our server will respond with a `429` status code. You can throttle your requests and retry them later.
The current limit, which you can see in the table below, has shown to be enough for most use cases. If you encounter `429` error codes, consider taking the following actions to minimize your APIs usage:
- Subscribe to webhooks events instead of polling the API for reacting to changes.
- Throttle the requests you send to the ThreatDown API for not exceeding the limit.
- Batch requests when possible.
- Contact us and request to increase the API quota for your application.
Currently, the default available quota is `360` requests per minute.
'
version: 1.0.0
x-logo:
altText: ThreatDown logo
url: https://assets.threatdown.com/hermes/ThreatDown_Horizontal_Navy.png
backgroundColor: '#FFFFFF'
servers:
- url: https://api.threatdown.com
tags:
- name: Products
paths:
/nebula/v1/products/categories:
get:
description: Get OPSWAT categories
summary: Get categories
security:
- client_credentials:
- read
- user_permissions: []
status:
outage:
- auth
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}$'
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
required:
- categories
properties:
categories:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
tags:
- Products
operationId: api.nebula.get.products.categories
/nebula/v1/products:
post:
description: Search OPSWAT products
summary: Search products
security:
- client_credentials:
- read
- user_permissions: []
status:
outage:
- auth
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:
title: Search OPSWAT Products with filters
type: object
properties:
constraints:
type: array
title: List of search constraints
items:
type: object
properties:
field:
type: string
title: Constraint field
enum:
- vendor_id
- vendor_name
- product_name
- platform
- methods
- categories
operator:
title: Constraint operator
type: string
enum:
- equals
- not_equals
- contains
- not_contains
value:
title: Value to search
type:
- string
- number
sort_field:
title: Sort Field
type: string
enum:
- vendor_name
- vendor_id
- product_name
- product_id
page_size:
type: number
title: Page size
minimum: 0
maximum: 500
next_cursor:
type: string
title: The pagination cursor for next set of results. For further documentation, check Pagination section.
examples:
- eyJzdGFydF9pbmRleCI6MTAwfQ==
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
required:
- total_count
- results
properties:
results:
type: array
items:
type: object
properties:
vendor_id:
type: string
product_id:
type: string
signatures:
type: array
items:
type: object
additionalProperties: false
properties:
signature_id:
type: string
signature_name:
type: string
vendor_name:
type: string
product_name:
type: string
platform:
type: string
categories:
type: array
items:
type: string
methods:
type: array
items:
type: string
required:
- signatures
- product_id
- vendor_id
total_count:
type: number
next_cursor:
type: string
tags:
- Products
operationId: api.nebula.post.products
/nebula/v1/products/vendors:
post:
description: Search OPSWAT vendors
summary: Search vendors
security:
- client_credentials:
- read
- user_permissions: []
status:
outage:
- auth
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:
title: Search OPSWAT Vendors with filters
type: object
properties:
constraints:
type: array
title: List of search constraints
items:
type: object
properties:
field:
type: string
title: Constraint field
enum:
- vendor_name
- platform
- methods
operator:
title: Constraint operator
type: string
enum:
- equals
- not_equals
- contains
- not_contains
value:
title: Value to search
type:
- string
- number
sort_field:
title: Sort Field
type: string
enum:
- vendor_name
- vendor_id
page_size:
type: number
title: Page size
minimum: 0
maximum: 500
next_cursor:
type: string
title: The pagination cursor for next set of results. For further documentation, check Pagination section.
examples:
- eyJzdGFydF9pbmRleCI6MTAwfQ==
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
required:
- total_count
- results
properties:
results:
type: array
items:
type: object
properties:
vendor_id:
type: string
vendor_name:
type: string
platform:
type: string
products:
type: array
items:
type: object
additionalProperties: false
properties:
vendor_id:
type: string
product_id:
type: string
signatures:
type: array
items:
type: object
additionalProperties: false
properties:
signature_id:
type: string
signature_name:
type: string
vendor_name:
type: string
product_name:
type: string
platform:
type: string
categories:
type: array
items:
type: string
methods:
type: array
items:
type: string
required:
- signatures
- product_id
- vendor_id
methods:
type: array
items:
type: string
total_count:
type: number
next_cursor:
type: string
tags:
- Products
operationId: api.nebula.post.products.vendors
components:
securitySchemes:
client_credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: /token
scopes:
read: Read data of your Nebula account
write: Write data, such as groups, policies, exclusions. Create Webhook subscriptions
execute: Issue jobs on your endpoints, like Scan, Reboot or Isolate.
user_permissions:
type: http
scheme: bearer