Malwarebytes App Block API
The App Block API from Malwarebytes — 20 operation(s) for app block.
OpenAPI Specification
openapi: 3.2.0
info:
title: Malwarebytes App Block API
version: 1.0.0
description: 'Operations tagged App Block 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: App Block
paths:
/nebula/v1/app-block/rules:
servers:
- url: https://api.threatdown.com
post:
description: Create a new App Block Rule
summary: Create App Block Rule
security:
- client_credentials:
- write
- user_permissions:
- appBlock.createRule
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:
type: object
title: Create App Block Rule Schema
required:
- rule
properties:
rule:
type: object
title: App Block Rule
required:
- name
- action
oneOf:
- title: Files
required:
- files
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: File properties
required:
- file_properties
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Hash
anyOf:
- title: Hash MD5
required:
- hashes_md5
- title: Hash SHA1
required:
- hashes_sha1
- title: Hash SHA256
required:
- hashes_sha256
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Applications
required:
- applications
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Vendors
required:
- vendors
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Certificate property
required:
- digital_signatures
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Categories
required:
- categories
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
properties:
name:
type: string
description: App Block Rule Name
examples:
- app_block_rule_1
action:
type: string
descripion: App Block Rule Action
enum:
- block
- report
- allow
files:
type: array
description: Blocked file paths
items:
type: string
examples:
- - /example/path/1
- /exapmle/path/2
file_properties:
type: array
description: Blocked file properties
items:
type: object
properties:
property:
type: string
value:
type: string
hashes_md5:
type: array
description: Blocked Md5 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha1:
type: array
description: Blocked SHA1 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha256:
type: array
description: Blocked SHA256 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
applications:
type: array
description: Blocked Applications
items:
type: object
properties:
vendor_id:
type: integer
description: OPSWAT Vendor Id
vendor_name:
type: string
description: OPSWAT Vendor Name
signature_id:
type: integer
description: OPSWAT Signature Id
signature_name:
type: string
description: OPSWAT Signature Name
product_name:
type: string
description: OPSWAT Product Name
product_id:
type: integer
description: OPSWAT Product ID
required:
- signature_id
examples:
- - vendor_id: '111'
vendor_name: Example Vendor
signature_id: '1111'
signature_name: Example Signature
product_id: Example Product Id
product_name: Example Produc Name
vendors:
type: array
description: Blocked Vendors
items:
type: object
properties:
vendor_id:
type: integer
description: OPSWAT Vendor Id
vendor_name:
type: string
description: OPSWAT Vendor Name
examples:
- - vendor_id: '1111'
vendor_name: Example Vendor
digital_signatures:
type: array
description: Blocked digital signatures
items:
type: object
properties:
property:
type: string
value:
type: string
categories:
type: array
description: Blocked categories
items:
type: integer
description: '0: ALL, 1: PUBLIC_FILE_SHARING, 2: BACKUP, 3: ENCRYPTION, 4: ANTIPHISHING, 5: ANTIMALWARE, 6: BROWSER, 7: FIREWALL, 8: MESSENGER, 9: CLOUD_STORAGE, 10: UNCLASSIFIED, 11: DATA_LOSS_PREVENTION, 12: PATCH_MANAGEMENT, 13: VPN_CLIENT, 14: VIRTUAL_MACHINE, 15: HEALTH_AGENT, 16: REMOTE_CONTROL, 17: P2PA, 18: WEB_CONFERENCE'
examples:
- - 1
type:
type: string
examples:
- files
- hashes
- file_properties
- applications
- vendors
- digital_signatures
- categories
oneOf:
- title: app block rule with new rule_set
required:
- enabled
properties:
name:
type: string
description: App Block Rule Set Name
policy_ids:
type: array
title: Policies associated with the rule
items:
type: string
title: Policy ID
format: uuid
examples:
- - 59bd2afa-501c-41a5-aa8e-c5886b6c7f36
- a54d8a47-d802-49e3-88b9-e8eaf7d8f148
policies_exclude:
type: boolean
title: If the property is true, the specified policies are excluded
default: false
enabled:
type: boolean
title: Enable the rule
default: true
- title: app block rule with existing rule_set
required:
- rule_set_id
properties:
rule_set_id:
type: string
title: Existing Rule set ID
format: uuid
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
properties:
rule:
allOf:
- type: object
title: App Block Rule
required:
- name
- action
oneOf:
- title: Files
required:
- files
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: File properties
required:
- file_properties
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Hash
anyOf:
- title: Hash MD5
required:
- hashes_md5
- title: Hash SHA1
required:
- hashes_sha1
- title: Hash SHA256
required:
- hashes_sha256
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Applications
required:
- applications
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Vendors
required:
- vendors
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Certificate property
required:
- digital_signatures
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Categories
required:
- categories
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
properties:
name:
type: string
description: App Block Rule Name
examples:
- app_block_rule_1
action:
type: string
descripion: App Block Rule Action
enum:
- block
- report
- allow
files:
type: array
description: Blocked file paths
items:
type: string
examples:
- - /example/path/1
- /exapmle/path/2
file_properties:
type: array
description: Blocked file properties
items:
type: object
properties:
property:
type: string
value:
type: string
hashes_md5:
type: array
description: Blocked Md5 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha1:
type: array
description: Blocked SHA1 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha256:
type: array
description: Blocked SHA256 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
applications:
type: array
description: Blocked Applications
items:
type: object
properties:
vendor_id:
type: integer
description: OPSWAT Vendor Id
vendor_name:
type: string
description: OPSWAT Vendor Name
signature_id:
type: integer
description: OPSWAT Signature Id
signature_name:
type: string
description: OPSWAT Signature Name
product_name:
type: string
description: OPSWAT Product Name
product_id:
type: integer
description: OPSWAT Product ID
required:
- signature_id
examples:
- - vendor_id: '111'
vendor_name: Example Vendor
signature_id: '1111'
signature_name: Example Signature
product_id: Example Product Id
product_name: Example Produc Name
vendors:
type: array
description: Blocked Vendors
items:
type: object
properties:
vendor_id:
type: integer
description: OPSWAT Vendor Id
vendor_name:
type: string
description: OPSWAT Vendor Name
examples:
- - vendor_id: '1111'
vendor_name: Example Vendor
digital_signatures:
type: array
description: Blocked digital signatures
items:
type: object
properties:
property:
type: string
value:
type: string
categories:
type: array
description: Blocked categories
items:
type: integer
description: '0: ALL, 1: PUBLIC_FILE_SHARING, 2: BACKUP, 3: ENCRYPTION, 4: ANTIPHISHING, 5: ANTIMALWARE, 6: BROWSER, 7: FIREWALL, 8: MESSENGER, 9: CLOUD_STORAGE, 10: UNCLASSIFIED, 11: DATA_LOSS_PREVENTION, 12: PATCH_MANAGEMENT, 13: VPN_CLIENT, 14: VIRTUAL_MACHINE, 15: HEALTH_AGENT, 16: REMOTE_CONTROL, 17: P2PA, 18: WEB_CONFERENCE'
examples:
- - 1
type:
type: string
examples:
- files
- hashes
- file_properties
- applications
- vendors
- digital_signatures
- categories
- required:
- id
properties:
id:
title: Rule ID
type: string
examples:
- 3606af9f-f539-426c-be76-6f9bc18531e2
created_at:
type: string
examples:
- '2022-11-09T14:34:04.181428Z'
created_by:
type: string
examples:
- a197e54e-facb-4767-81fe-1e55bd34f0c9
updated_at:
type: string
examples:
- '2022-11-09T14:34:04.181428Z'
updated_by:
type: string
examples:
- a197e54e-facb-4767-81fe-1e55bd34f0c9
rule_set_id:
type: string
format: uuid
title: Rule Set ID
created_at:
type: string
examples:
- '2022-11-09T14:34:04.181428Z'
created_by:
type: string
examples:
- a197e54e-facb-4767-81fe-1e55bd34f0c9
updated_at:
type: string
examples:
- '2022-11-09T14:34:04.181428Z'
updated_by:
type: string
examples:
- a197e54e-facb-4767-81fe-1e55bd34f0c9
policies:
type: array
items:
type: object
properties:
policy_id:
type: string
policy_name:
type: string
deleted_at:
type: string
accounts:
type: array
items:
type: object
properties:
account_id:
type: string
account_name:
type: string
deleted_at:
type: string
tags:
- App Block
operationId: api.nebula.post.app_block_rule
/nebula/v1/app-block/rules/{id}:
servers:
- url: https://api.threatdown.com
delete:
description: Delete an existing App Block Rule by its id.
summary: Delete App Block Rule
security:
- client_credentials:
- write
- user_permissions:
- appBlock.delete
status:
outage:
- auth
parameters:
- name: id
required: true
in: path
description: Valid UUID (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}$'
- 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: Successful response
tags:
- App Block
operationId: api.nebula.delete.app_block_rule
get:
description: Get an App Block Rule by ID
summary: Get App Block Rule
security:
- client_credentials:
- read
- user_permissions:
- appBlock.view
status:
outage:
- auth
parameters:
- name: id
required: true
in: path
description: Valid UUID (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}$'
- 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
properties:
rule:
allOf:
- type: object
title: App Block Rule
required:
- name
- action
oneOf:
- title: Files
required:
- files
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: File properties
required:
- file_properties
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Hash
anyOf:
- title: Hash MD5
required:
- hashes_md5
- title: Hash SHA1
required:
- hashes_sha1
- title: Hash SHA256
required:
- hashes_sha256
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Applications
required:
- applications
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Vendors
required:
- vendors
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Certificate property
required:
- digital_signatures
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
- title: Categories
required:
- categories
errorMessage: Rule must have only one among files, (hashes_md5 and/or hashes_sha1 and/or hashes_sha256), file_properties, applications, vendors, digital_signatures, categories.
properties:
name:
type: string
description: App Block Rule Name
examples:
- app_block_rule_1
action:
type: string
descripion: App Block Rule Action
enum:
- block
- report
- allow
files:
type: array
description: Blocked file paths
items:
type: string
examples:
- - /example/path/1
- /exapmle/path/2
file_properties:
type: array
description: Blocked file properties
items:
type: object
properties:
property:
type: string
value:
type: string
hashes_md5:
type: array
description: Blocked Md5 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha1:
type: array
description: Blocked SHA1 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
- hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 456
hashes_sha256:
type: array
description: Blocked SHA256 hashes
items:
type: object
properties:
hash:
type: string
size:
type: number
examples:
- - hash: 36c5d12033b2eaf251bae61c00690ffb17fddc87
size: 123
# --- truncated at 32 KB (442 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/malwarebytes/refs/heads/main/openapi/malwarebytes-app-block-api-openapi.yml