Malwarebytes Sandbox API
The Sandbox API from Malwarebytes — 2 operation(s) for sandbox.
OpenAPI Specification
openapi: 3.2.0
info:
title: ThreatDown Sandbox 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: Sandbox
paths:
/nebula/v1/sandbox/submissions:
post:
description: Search the sandbox submission results
summary: Search the sandbox submission results
security:
- client_credentials:
- read
- user_permissions:
- edr.manage
status:
outage:
- auth
- edr
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: Sandbox submissions search request
type: object
additionalProperties: false
properties:
file_name:
type: string
md5:
type: string
pattern: ^[a-fA-F0-9]{32}$
result:
type: array
items:
type: string
enum:
- clean
- malicious
- unknown
status:
type: array
items:
type: string
enum:
- pending
- processing
ext:
type: array
items:
type: string
enum:
- exe32
- exe64
- dll32
- dll64
upload_source:
type: string
items:
type: string
enum:
- ars
- automatic
- frs
- manual
- sa
timestamp:
gte:
type: string
examples:
- '2023-11-16 00:00:00'
lte:
type: string
examples:
- '2023-11-16 23:59:59'
time_zone:
type: string
examples:
- +02:00
responses:
'200':
description: response schema
content:
application/json:
schema:
title: Sandbox submissions response schema
type: object
additionalProperties: false
properties:
data:
total_unfiltered:
type: number
total:
type: number
rows:
type: array
items:
type: object
properties:
id:
type: number
upload_source:
type: string
account_id:
type: string
format: uuid
file_path:
type: string
machine_id:
type: string
format: uuid
pc_hostname:
type: string
timestamp:
type: string
file_name:
type: string
file_size:
type: number
rule_count:
type: number
status:
type: string
result:
type: string
md5:
type: string
sha512:
type: string
sha1:
type: string
sha256:
type: string
ext:
type: string
file_format:
type: string
tags:
- Sandbox
operationId: api.nebula.search.sandbox.submissions
/nebula/v1/sandbox/upload:
post:
description: Upload file to the sandbox
summary: Upload file to the sandbox
security:
- client_credentials:
- write
- user_permissions:
- edr.manage
status:
outage:
- auth
- edr
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: Sandbox file upload request
type: object
additionalProperties: false
properties:
machine_id:
type: string
format: uuid
title: Machine ID
process_path:
type: string
title: Process Path
pc_hostname:
type: string
title: PC Hostname
responses:
'200':
description: response schema
content:
application/json:
schema:
title: Sandbox file upload request
type: object
additionalProperties: false
properties:
status:
type: string
title: status
tags:
- Sandbox
operationId: api.nebula.sandbox.upload
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