Malwarebytes Content Filtering API
The Content Filtering APIs are for managing content filtering rules used by the DNS module. These rules control what domains or categories of domains your endpoints have access to.
OpenAPI Specification
openapi: 3.2.0
info:
title: Malwarebytes Content Filtering API
version: 1.0.0
description: 'Operations tagged Content Filtering 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: Content Filtering
description: The Content Filtering APIs are for managing content filtering rules used by the DNS module. These rules control what domains or categories of domains your endpoints have access to.
paths:
/nebula/v1/content-filtering:
servers:
- url: https://api.threatdown.com
post:
description: Create a new content filtering rule
summary: Create content filtering rule
security:
- client_credentials:
- write
- user_permissions:
- dnsFiltering.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/Update content filtering rule request
required:
- name
- enabled
properties:
name:
type: string
description: Name of the content filtering rule
examples:
- test_rule_1
description:
type: string
description: Description of the content filtering rule
examples:
- This is a test rule
security_categories:
type: array
description: Security categories
items:
type: integer
examples:
- - 150
- 151
- 152
- 153
content_categories:
type: array
description: Content categories
items:
type: integer
examples:
- - 130
- 131
- 133
- 134
- 135
allow_domains:
type: array
description: List of allowed domains
items:
type: string
examples:
- - ex.com
- we.com
- eee.com
block_domains:
type: array
description: List of blocked domains
items:
type: string
examples:
- - a.com
- b.com
- c.com
allow_ips:
type: array
description: List of allowed IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.20.0
- 192.168.0.0/24
block_ips:
type: array
description: List of blocked IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.30.40
- 192.168.10.0/24
block_tlds:
type: array
description: Blocked Top Level Domains (TLDs)
items:
type: string
examples:
- - pt
doh_url:
type: string
description: DOH URL
examples:
- abcdef.cloudflare.com
policy_ids:
type: array
description: List of policy IDs
items:
type: string
examples:
- - 575ec9d1-9ade-4a2b-98cd-d6b5e5ea63d7
enabled:
type: boolean
description: Content filtering rule enabled/disabled status
examples:
- true
examples:
- name: test_rule_1
description: This is a test rule
security_categories:
- 150
- 151
- 152
- 153
content_categories:
- 130
- 131
- 133
- 134
- 135
allow_domains:
- ex.com
- we.com
- eee.com
block_domains:
- a.com
- b.com
- c.com
allow_ips:
- 10.20.20.0
- 192.168.0.0/24
block_ips:
- 10.20.30.40
- 192.168.10.0/24
block_tlds:
- pt
policy_ids:
- 575ec9d1-9ade-4a2b-98cd-d6b5e5ea63d7
enabled: true
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
title: Content filtering rule
properties:
id:
type: string
description: Content filtering rule ID
examples:
- a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id:
type: string
description: Your account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id:
type: string
description: Parent account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
name:
type: string
description: Name of the content filtering rule
examples:
- test_rule_1
description:
type: string
description: Description of the content filtering rule
examples:
- This is a test rule
security_categories:
type: array
description: Security categories
items:
type: integer
examples:
- - 150
- 151
- 152
- 153
content_categories:
type: array
description: Content categories
items:
type: integer
examples:
- - 130
- 131
- 133
- 134
- 135
allow_domains:
type: array
description: Allow domains
items:
type: string
examples:
- - ex.com
- we.com
- eee.com
block_domains:
type: array
description: Block domains
items:
type: string
examples:
- - a.com
- b.com
- c.com
allow_ips:
type: array
description: List of allowed IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.20.0
- 192.168.0.0/24
block_ips:
type: array
description: List of blocked IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.30.40
- 192.168.10.0/24
block_tlds:
type: array
description: Blocked Top Level Domains (TLDs)
items:
type: string
examples:
- - pt
doh_url:
type: string
description: DOH URL
examples:
- abcdef.cloudflare.com
policies:
type: array
description: Policies
items:
type: object
properties:
policy_id:
type: string
description: Policy ID
policy_name:
type: string
description: Policy name
created_at:
type: string
description: Rule creation time
examples:
- '2022-03-22T11:04:30.977497Z'
created_by:
type: string
description: Rule creator ID
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
updated_at:
type: string
description: Rule update time
examples:
- '2022-03-22T11:44:38.35927Z'
updated_by:
type: string
description: Rule updated by
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
enabled:
type: boolean
description: Content filtering rule enabled/disabled status
examples:
- true
examples:
- id: a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
name: test_rule_1_modified
description: This is a test rule
security_categories:
- 150
- 151
- 152
- 153
content_categories:
- 1
- 2
- 3
- 4
- 5
allow_domains:
- ex.com
- we.com
- eee.com
block_domains:
- a.com
- b.com
- c.com
allow_ips:
- 10.20.20.0
- 192.168.0.0/24
block_ips:
- 10.20.30.40
- 192.168.10.0/24
block_tlds:
- pt
doh_url: abcdef.cloudflare.com
policies:
- policy_id: 59bd2afa-501c-41a5-aa8e-c5886b6c7f36
policy_name: Policy Test
created_at: '2022-03-22T11:04:30.977497Z'
created_by: d338949c-a186-4e06-aebe-67249e48a88c
updated_at: '2022-03-22T11:44:38.35927Z'
updated_by: d338949c-a186-4e06-aebe-67249e48a88c
enabled: true
tags:
- Content Filtering
operationId: api.nebula.post.content_filtering_rule
/nebula/v1/content-filtering/{id}:
servers:
- url: https://api.threatdown.com
delete:
description: Delete a content filtering rule
summary: Delete content filtering rule
security:
- client_credentials:
- write
- user_permissions:
- dnsFiltering.deleteRule
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:
- Content Filtering
operationId: api.nebula.delete.content_filtering_rule
get:
description: Get a content filtering rule details by id
summary: Get a content filtering rule details
security:
- client_credentials:
- read
- user_permissions:
- dnsFiltering.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
title: Content filtering rule
properties:
id:
type: string
description: Content filtering rule ID
examples:
- a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id:
type: string
description: Your account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id:
type: string
description: Parent account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
name:
type: string
description: Name of the content filtering rule
examples:
- test_rule_1
description:
type: string
description: Description of the content filtering rule
examples:
- This is a test rule
security_categories:
type: array
description: Security categories
items:
type: integer
examples:
- - 150
- 151
- 152
- 153
content_categories:
type: array
description: Content categories
items:
type: integer
examples:
- - 130
- 131
- 133
- 134
- 135
allow_domains:
type: array
description: Allow domains
items:
type: string
examples:
- - ex.com
- we.com
- eee.com
block_domains:
type: array
description: Block domains
items:
type: string
examples:
- - a.com
- b.com
- c.com
allow_ips:
type: array
description: List of allowed IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.20.0
- 192.168.0.0/24
block_ips:
type: array
description: List of blocked IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.30.40
- 192.168.10.0/24
block_tlds:
type: array
description: Blocked Top Level Domains (TLDs)
items:
type: string
examples:
- - pt
doh_url:
type: string
description: DOH URL
examples:
- abcdef.cloudflare.com
policies:
type: array
description: Policies
items:
type: object
properties:
policy_id:
type: string
description: Policy ID
policy_name:
type: string
description: Policy name
created_at:
type: string
description: Rule creation time
examples:
- '2022-03-22T11:04:30.977497Z'
created_by:
type: string
description: Rule creator ID
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
updated_at:
type: string
description: Rule update time
examples:
- '2022-03-22T11:44:38.35927Z'
updated_by:
type: string
description: Rule updated by
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
enabled:
type: boolean
description: Content filtering rule enabled/disabled status
examples:
- true
examples:
- id: a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
name: test_rule_1_modified
description: This is a test rule
security_categories:
- 150
- 151
- 152
- 153
content_categories:
- 1
- 2
- 3
- 4
- 5
allow_domains:
- ex.com
- we.com
- eee.com
block_domains:
- a.com
- b.com
- c.com
allow_ips:
- 10.20.20.0
- 192.168.0.0/24
block_ips:
- 10.20.30.40
- 192.168.10.0/24
block_tlds:
- pt
doh_url: abcdef.cloudflare.com
policies:
- policy_id: 59bd2afa-501c-41a5-aa8e-c5886b6c7f36
policy_name: Policy Test
created_at: '2022-03-22T11:04:30.977497Z'
created_by: d338949c-a186-4e06-aebe-67249e48a88c
updated_at: '2022-03-22T11:44:38.35927Z'
updated_by: d338949c-a186-4e06-aebe-67249e48a88c
enabled: true
tags:
- Content Filtering
operationId: api.nebula.get.content_filtering_rule.id
put:
description: Update a content filtering rule
summary: Update content filtering rule
security:
- client_credentials:
- write
- user_permissions:
- dnsFiltering.editRule
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
title: Create/Update content filtering rule request
required:
- name
- enabled
properties:
name:
type: string
description: Name of the content filtering rule
examples:
- test_rule_1
description:
type: string
description: Description of the content filtering rule
examples:
- This is a test rule
security_categories:
type: array
description: Security categories
items:
type: integer
examples:
- - 150
- 151
- 152
- 153
content_categories:
type: array
description: Content categories
items:
type: integer
examples:
- - 130
- 131
- 133
- 134
- 135
allow_domains:
type: array
description: List of allowed domains
items:
type: string
examples:
- - ex.com
- we.com
- eee.com
block_domains:
type: array
description: List of blocked domains
items:
type: string
examples:
- - a.com
- b.com
- c.com
allow_ips:
type: array
description: List of allowed IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.20.0
- 192.168.0.0/24
block_ips:
type: array
description: List of blocked IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.30.40
- 192.168.10.0/24
block_tlds:
type: array
description: Blocked Top Level Domains (TLDs)
items:
type: string
examples:
- - pt
doh_url:
type: string
description: DOH URL
examples:
- abcdef.cloudflare.com
policy_ids:
type: array
description: List of policy IDs
items:
type: string
examples:
- - 575ec9d1-9ade-4a2b-98cd-d6b5e5ea63d7
enabled:
type: boolean
description: Content filtering rule enabled/disabled status
examples:
- true
examples:
- name: test_rule_1
description: This is a test rule
security_categories:
- 150
- 151
- 152
- 153
content_categories:
- 130
- 131
- 133
- 134
- 135
allow_domains:
- ex.com
- we.com
- eee.com
block_domains:
- a.com
- b.com
- c.com
allow_ips:
- 10.20.20.0
- 192.168.0.0/24
block_ips:
- 10.20.30.40
- 192.168.10.0/24
block_tlds:
- pt
policy_ids:
- 575ec9d1-9ade-4a2b-98cd-d6b5e5ea63d7
enabled: true
responses:
'200':
description: response schema
content:
application/json:
schema:
type: object
title: Content filtering rule
properties:
id:
type: string
description: Content filtering rule ID
examples:
- a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id:
type: string
description: Your account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id:
type: string
description: Parent account ID
examples:
- 550a20b8-6d36-4222-afbc-54d100f2e894
name:
type: string
description: Name of the content filtering rule
examples:
- test_rule_1
description:
type: string
description: Description of the content filtering rule
examples:
- This is a test rule
security_categories:
type: array
description: Security categories
items:
type: integer
examples:
- - 150
- 151
- 152
- 153
content_categories:
type: array
description: Content categories
items:
type: integer
examples:
- - 130
- 131
- 133
- 134
- 135
allow_domains:
type: array
description: Allow domains
items:
type: string
examples:
- - ex.com
- we.com
- eee.com
block_domains:
type: array
description: Block domains
items:
type: string
examples:
- - a.com
- b.com
- c.com
allow_ips:
type: array
description: List of allowed IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.20.0
- 192.168.0.0/24
block_ips:
type: array
description: List of blocked IPs (IPV4 address or CIDR block)
items:
type: string
examples:
- - 10.20.30.40
- 192.168.10.0/24
block_tlds:
type: array
description: Blocked Top Level Domains (TLDs)
items:
type: string
examples:
- - pt
doh_url:
type: string
description: DOH URL
examples:
- abcdef.cloudflare.com
policies:
type: array
description: Policies
items:
type: object
properties:
policy_id:
type: string
description: Policy ID
policy_name:
type: string
description: Policy name
created_at:
type: string
description: Rule creation time
examples:
- '2022-03-22T11:04:30.977497Z'
created_by:
type: string
description: Rule creator ID
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
updated_at:
type: string
description: Rule update time
examples:
- '2022-03-22T11:44:38.35927Z'
updated_by:
type: string
description: Rule updated by
examples:
- d338949c-a186-4e06-aebe-67249e48a88c
enabled:
type: boolean
description: Content filtering rule enabled/disabled status
examples:
- true
examples:
- id: a54d8a47-d802-49e3-88b9-e8eaf7d8f148
account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
parent_account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
name: test_rule_1_modified
description: This is a test rule
security_categories:
- 150
- 151
- 152
- 153
content_categories:
- 1
- 2
- 3
- 4
- 5
allow_domains:
- ex.com
- we.com
- eee.com
block_domains:
- a.com
- b.com
- c.com
allow_ips:
- 10.20.20.0
- 192.168.0.0/24
block_ips:
- 10.20.30.40
- 192.168.10.0/24
block_tlds:
- pt
doh_url: abcdef.cloudflare.com
policies:
- policy_id: 59bd2afa-501c-41a5-aa8e-c5886b6c7f36
policy_name:
# --- truncated at 32 KB (191 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/malwarebytes/refs/heads/main/openapi/malwarebytes-content-filtering-api-openapi.yml