Malwarebytes Ignore Rules API
The Ignore Rules API from Malwarebytes — 4 operation(s) for ignore rules.
OpenAPI Specification
openapi: 3.2.0
info:
title: Malwarebytes Ignore Rules API
version: 1.0.0
description: 'Operations tagged Ignore Rules 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: Ignore Rules
paths:
/nebula/v1/assets/ignore-rules:
servers:
- url: https://api.threatdown.com
post:
description: Create a new asset ignore rule.
summary: Create asset ignore rule
security:
- client_credentials:
- write
- user_permissions:
- patchManagement.manage
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
description: Create ignore rule
allOf:
- type: object
description: Ignore rule
required:
- type
- name
- os_platform
- config
properties:
type:
type: string
description: Type of ignore rule
enum:
- os-patch
- software-update
name:
type: string
description: Name of the ignore rule
os_platform:
type: string
description: Operating system platform the ignore rule applies to
enum:
- windows
- macos
- linux
config:
type: object
description: Ignore rule configuration
properties:
patch_ids:
type: array
description: Patch IDs to ignore
items:
type: string
applications:
type: array
description: Applications to ignore
items:
type: object
properties:
product:
type: number
versions:
oneOf:
- type: 'null'
- type: array
items:
type: string
minItems: 1
expires_at:
type: string
description: Date when the ignore rule expires
format: date-time
reason:
type: string
description: Reason for creating the ignore rule
if:
properties:
type:
const: os-patch
then:
properties:
config:
required:
- patch_ids
properties:
patch_ids:
minItems: 1
not:
required:
- applications
else:
properties:
config:
required:
- applications
properties:
applications:
minItems: 1
not:
required:
- patch_ids
- properties:
policy_ids:
type: array
description: list of policy IDs the ignore rule applies to
items:
type: string
format: uuid
patch_titles:
type: array
description: list of patch titles the ignore rule applies to
items:
type: string
application_names:
type: array
description: list of application names the ignore rule applies to
items:
type: string
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
description: Ignore rule response schema
allOf:
- type: object
description: Ignore rule
required:
- type
- name
- os_platform
- config
properties:
type:
type: string
description: Type of ignore rule
enum:
- os-patch
- software-update
name:
type: string
description: Name of the ignore rule
os_platform:
type: string
description: Operating system platform the ignore rule applies to
enum:
- windows
- macos
- linux
config:
type: object
description: Ignore rule configuration
properties:
patch_ids:
type: array
description: Patch IDs to ignore
items:
type: string
applications:
type: array
description: Applications to ignore
items:
type: object
properties:
product:
type: number
versions:
oneOf:
- type: 'null'
- type: array
items:
type: string
minItems: 1
expires_at:
type: string
description: Date when the ignore rule expires
format: date-time
reason:
type: string
description: Reason for creating the ignore rule
if:
properties:
type:
const: os-patch
then:
properties:
config:
required:
- patch_ids
properties:
patch_ids:
minItems: 1
not:
required:
- applications
else:
properties:
config:
required:
- applications
properties:
applications:
minItems: 1
not:
required:
- patch_ids
- properties:
id:
type: string
format: uuid
description: Unique identifier for the ignore rule
created_at:
type: string
description: Timestamp when the ignore rule was created
updated_at:
type: string
description: Timestamp when the ignore rule was last updated
created_by:
type: string
description: Identifier of the user who created the ignore rule
updated_by:
type: string
description: Identifier of the user who last updated the ignore rule
policies:
type:
- array
- 'null'
description: List of policies associated with the ignore rule
items:
type: object
properties:
policy_id:
type: string
format: uuid
policy_name:
type: string
ignore_rule_id:
type: string
format: uuid
account_id:
type: string
format: uuid
patches:
type:
- array
description: Ignored patches details
items:
type: object
properties:
title:
type: string
kb_id:
type: string
tags:
- Ignore Rules
operationId: api.nebula.post.assets.ignore-rules
delete:
description: Bulk delete existing asset ignore rules.
summary: Bulk delete asset ignore rules
security:
- client_credentials:
- write
- user_permissions:
- patchManagement.manage
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
description: Delete ignore rules in bulk
properties:
rule_ids:
type: array
description: List of ignore rule IDs to delete
items:
type: string
format: uuid
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
description: Response after deleting ignore rules in bulk
properties:
deleted:
type: array
description: List of successfully deleted ignore rule IDs
items:
type: string
format: uuid
errors:
type: array
description: List of ignore rule IDs that failed to delete, if any
items:
type: string
format: uuid
not_found:
type: array
description: List of ignore rule IDs that were not found
items:
type: string
format: uuid
tags:
- Ignore Rules
operationId: api.nebula.delete.assets.ignore-rules.bulk
get:
description: Get asset ignore rules.
summary: Get asset ignore rules
security:
- client_credentials:
- read
- user_permissions:
- patchManagement.view
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}$'
- name: page_size
required: false
in: query
schema:
type: number
- name: next_cursor
required: false
in: query
schema:
type: string
- name: type
required: false
in: query
schema:
type: string
enum:
- os-patch
- software-update
- name: ids
required: false
in: query
schema:
type: string
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
description: Search ignore rules response schema
properties:
ignore_rules:
type: array
description: List of ignore rules
items:
type: object
description: Ignore rule response schema
allOf:
- type: object
description: Ignore rule
required:
- type
- name
- os_platform
- config
properties:
type:
type: string
description: Type of ignore rule
enum:
- os-patch
- software-update
name:
type: string
description: Name of the ignore rule
os_platform:
type: string
description: Operating system platform the ignore rule applies to
enum:
- windows
- macos
- linux
config:
type: object
description: Ignore rule configuration
properties:
patch_ids:
type: array
description: Patch IDs to ignore
items:
type: string
applications:
type: array
description: Applications to ignore
items:
type: object
properties:
product:
type: number
versions:
oneOf:
- type: 'null'
- type: array
items:
type: string
minItems: 1
expires_at:
type: string
description: Date when the ignore rule expires
format: date-time
reason:
type: string
description: Reason for creating the ignore rule
if:
properties:
type:
const: os-patch
then:
properties:
config:
required:
- patch_ids
properties:
patch_ids:
minItems: 1
not:
required:
- applications
else:
properties:
config:
required:
- applications
properties:
applications:
minItems: 1
not:
required:
- patch_ids
- properties:
id:
type: string
format: uuid
description: Unique identifier for the ignore rule
created_at:
type: string
description: Timestamp when the ignore rule was created
updated_at:
type: string
description: Timestamp when the ignore rule was last updated
created_by:
type: string
description: Identifier of the user who created the ignore rule
updated_by:
type: string
description: Identifier of the user who last updated the ignore rule
policies:
type:
- array
- 'null'
description: List of policies associated with the ignore rule
items:
type: object
properties:
policy_id:
type: string
format: uuid
policy_name:
type: string
ignore_rule_id:
type: string
format: uuid
account_id:
type: string
format: uuid
patches:
type:
- array
description: Ignored patches details
items:
type: object
properties:
title:
type: string
kb_id:
type: string
total_count:
type: integer
description: Total number of ignore rules
required:
- ignore_rules
- total_count
tags:
- Ignore Rules
operationId: api.nebula.get.assets.ignore-rules
/nebula/v1/assets/ignore-rules/{id}:
servers:
- url: https://api.threatdown.com
delete:
description: Delete an existing asset ignore rule.
summary: Delete asset ignore rule
security:
- client_credentials:
- write
- user_permissions:
- patchManagement.manage
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:
- Ignore Rules
operationId: api.nebula.delete.assets.ignore-rules
get:
description: Get asset ignore rule details by id.
summary: Get asset ignore rule details
security:
- client_credentials:
- read
- user_permissions:
- patchManagement.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
description: Ignore rule response schema
allOf:
- type: object
description: Ignore rule
required:
- type
- name
- os_platform
- config
properties:
type:
type: string
description: Type of ignore rule
enum:
- os-patch
- software-update
name:
type: string
description: Name of the ignore rule
os_platform:
type: string
description: Operating system platform the ignore rule applies to
enum:
- windows
- macos
- linux
config:
type: object
description: Ignore rule configuration
properties:
patch_ids:
type: array
description: Patch IDs to ignore
items:
type: string
applications:
type: array
description: Applications to ignore
items:
type: object
properties:
product:
type: number
versions:
oneOf:
- type: 'null'
- type: array
items:
type: string
minItems: 1
expires_at:
type: string
description: Date when the ignore rule expires
format: date-time
reason:
type: string
description: Reason for creating the ignore rule
if:
properties:
type:
const: os-patch
then:
properties:
config:
required:
- patch_ids
properties:
patch_ids:
minItems: 1
not:
required:
- applications
else:
properties:
config:
required:
- applications
properties:
applications:
minItems: 1
not:
required:
- patch_ids
- properties:
id:
type: string
format: uuid
description: Unique identifier for the ignore rule
created_at:
type: string
description: Timestamp when the ignore rule was created
updated_at:
type: string
description: Timestamp when the ignore rule was last updated
created_by:
type: string
description: Identifier of the user who created the ignore rule
updated_by:
type: string
description: Identifier of the user who last updated the ignore rule
policies:
type:
- array
- 'null'
description: List of policies associated with the ignore rule
items:
type: object
properties:
policy_id:
type: string
format: uuid
policy_name:
type: string
ignore_rule_id:
type: string
format: uuid
account_id:
type: string
format: uuid
patches:
type:
- array
description: Ignored patches details
items:
type: object
properties:
title:
type: string
kb_id:
type: string
tags:
- Ignore Rules
operationId: api.nebula.get.assets.ignore-rules.id
put:
description: Update an existing asset ignore rule.
summary: Update asset ignore rule
security:
- client_credentials:
- write
- user_permissions:
- patchManagement.manage
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}$'
requestBody:
content:
application/json:
schema:
type: object
description: Create ignore rule
allOf:
- type: object
description: Ignore rule
required:
- type
- name
- os_platform
- config
properties:
type:
type: string
description: Type of ignore rule
enum:
- os-patch
- software-update
name:
type: string
description: Name of the ignore rule
os_platform:
type: string
description: Operating system platform the ignore rule applies to
enum:
- windows
- macos
- linux
config:
type: object
description: Ignore rule configuration
properties:
patch_ids:
type: array
description: Patch IDs to ignore
items:
type: string
applications:
type: array
description: Applications to ignore
items:
type: object
properties:
product:
type: number
versions:
oneOf:
- type: 'null'
- type: array
items:
type: string
minItems: 1
expires_at:
type: string
description: Date when the ignore rule expires
format: date-time
reason:
type: string
description: Reason for creating the ignore rule
if:
properties:
type:
const: os-patch
then:
properties:
config:
required:
- patch_ids
properties:
patch_ids:
minItems: 1
not:
required:
- applications
else:
properties:
config:
required:
- applications
properties:
applications:
minItems: 1
not:
required:
- patch_ids
- properties:
policy_ids:
type: array
description: list of policy IDs the ignore rule applies to
items:
type: string
format: uuid
patch_titles:
type: array
description: list of patch titles the ignore rule applies to
items:
type: string
application_names:
type: array
description: list of application names the ignore rule applies to
items:
type: string
responses:
'200':
description: response schema
content:
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/malwarebytes/refs/heads/main/openapi/malwarebytes-ignore-rules-api-openapi.yml