Skip to main content

Cyware Orchestrate

Bitdefender

App Vendor: Bitdefender

App Category: Network Security

Connector Version: 2.1.0

API Version: 1.0.0

About App

The Bitdefender app helps security teams protect systems by detecting and mitigating threats in real-time across multiple environments.

The Bitdefender app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Get Accounts List 

This action retrieves the accounts list from Bitdefender.

Get Packages List 

This action retrieves the packages list from Bitdefender.

Add Items To Blocklist 

This action adds items to blocklist.

Get Blocklist Items

This action retrieves the items from blocklist.

Remove Items From Blocklist 

This action removes the items from blocklist.

Create Task to Isolate Specific Endpoint 

This action creates a task to isolate the specific endpoint.

Create Task to Restore Endpoint From Isolation

This action creates a task to restore the isolated specific endpoint

Get Endpoints List 

This action retrieves the list of endpoints.

Generic Action 

This is a generic action used to make requests to any Bitdefender endpoint.

Configuration Parameters

The following configuration parameters are required for the Bitdefender app to communicate with the Bitdefender enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL 

Enter the base URL to access Bitdefender. 

Example: 

https://{subdomain}.bitdefender.com

Text

Required

Username 

Enter your Bitdefender username.

Text

Required

Password 

Enter your Bitdefender password.

Password

Optional

Verify 

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.

Boolean

Optional

By default, verification is enabled.

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Bitdefender.

Integer

Optional

Allowed range:

15-120

Default value:

15

Action: Add Items To Blocklist

This action adds one or more file hashes to the blocklist.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Hash Type 

Enter the hash type.

Example:

2

Integer

Required

Allowed values:

1 for SHA256 and 2 for MD5. 

Hash List 

Enter the hash list. All the values must match the type specified in the Hash Type parameter.

Example:

[5b7ac19bb1a43dfb107b23c6, f696282aa4cd4f614aa995190cf442fe]

List

Required

Source Info 

Enterthe description for adding the hash values to the blocklist. 

Example:

Added from public API

Text

Required

Example Request

[
  {
    "hash_list": [
      "b95663ec7339033cf1fde459a34b6108"
    ],
    "hash_type": "2",
    "source_info": "Added from public API"
  }
]
Action: Create Task to Isolate Specific Endpoint

This action creates a task to isolate the specific endpoint.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Endpoint ID 

Enter the ID of the endpoint to be isolated. 

Example:

5b680f6fb1a43d860a7b23c1

Text

Required

You can retrieve this using the action Get Endpoints List.

Example Request 

[
  {
    "endpoint_id":"5b680f6fb1a43d860a7b23c1"
  }
]
Action: Create Task to Restore Endpoint From Isolation

This action creates a task to restore the isolated specific endpoint.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Endpoint ID 

Enter the ID of the endpoint to be restored. 

Example:

5b680f6fb1a43d860a7b23c1

Text

Required

You can retrieve this using the action Get Endpoints List.

Example Request 

[
  {
    "endpoint_id":"5b680f6fb1a43d860a7b23c1"
  }
]
Action: Get Accounts List

This action retrieves the list of accounts from Bitdefender. It will return an empty list if there are no user accounts.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Page Number 

Enter the page number to retrieve results from. 

Example:

10

Integer

Optional

Default value:

1

Per Page 

Enter the number of results to retrieve in each page.

Example:

20

Integer

Optional

Allowed range: 

1-100 

Default value:

30

Example Request

[
  {
    "per_page": "30",
    "page_number": "1"
  }
]
Action: Get Blocklist Items

This action retrieves items from the blocklist.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Page

Enter the page number to retrieve results from.

Example:

10

Integer

Optional

Default value:

1

Per Page 

Enter the number of results to retrieve in each page. 

Example:

20

Integer

Optional

Allowed range:

1-100

Default value:

30

Example Request

[
  {
    "per_page": "2",
    "page_number": "1"
  }
]
Action: Get Packages List

This action retrieves a list of packages from Bitdefender.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Page

Enter the page number to retrieve results from.

Example:

10

Integer

Optional

Default value:

1

Per Page 

Enter the number of results to retrieve in each page. 

Example:

20

Integer

Optional

Allowed range: 

1-100

Default value:

30

Example Request

[
  {
    "per_page": "30",
    "page_number": "1"
  }
]
Action: Remove Items From Blocklist

This action removes the items from the blocklist, identified by its ID.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Hash Item ID 

Enter the hash item ID to be removed from the blocklist.

Example:

5b680f6fb1a43d860a7b23c1

Text

Required

You can retrieve this using the action Get Blocklist Items.

Example Request 

[
  {
    "hash_item_id": "66d1e6c0153f933e6b08adb3"
  }
]
Action: Get Endpoints List

This action retrieves the list of endpoints.

Action Input Parameters 

Parameter 

Description 

Field Type 

Required/Optional 

Comments 

Parent ID 

Enter the ID of the target company or group. If not specified, it returns items from the company linked to the API key.

Example: 

63c6bb02e3cb799758020b99

Text

Optional

You can retrieve this using the action Get Accounts List.

Is Managed 

Enter true to retrieve only managed endpoints. If you enter false, it returns all the managed and unmanaged endpoints.

Boolean

Optional

By default, this action returns all the managed and unmanaged endpoints.

Page 

Enter the page number to retrieve results from. 

Example:

10

Integer

Optional

Default value:

1

Per Page 

Enter the number of results to retrieve in each page. 

Integer

Optional

Allowed range: 

1 -100

Default value:

30

Filters 

Enter the filters to narrow down the response. 

Example: 

"managedWithBest": true

Any

Optional

Allowed keys:

managedWithBest, managedExchangeServers, managedRelays, securityServers, allItemsRecursively, ssid, macs, name

For more information about allowed values, see Bitdefender API Documentation.

Options

Enter the set of options to define the content of the response.

Example:

"options": {"returnProductOutdated": true, "includeScanLogs": true}

Any

Optional

Example Request 

[
  {
   "parentId": "63c6bb02e3cb799758020b99",
   "page": 1,
   "perPage": 3,
   "filters": 
       {
         "security": 
             {
              "management": 
                 {
                   "managedWithBest": true,
                   "managedRelays": true
                }
             }
        }
  }
]
Action: Generic Action

This is a generic action used to make requests to any Bitdefender endpoint.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Method

Enter the HTTP method to make the request.

Text

Required

Allowed values:

GET, PUT, POST, DELETE

Endpoint

Enter the endpoint to make the request.

Example: 

/network

Text

Required

Query Params

Enter the query parameters to pass to the API.

Key Value

Optional

Payload

Enter the payload to pass to the API.

Any

Optional

Extra Fields

Enter the extra fields to pass to the API. 

Key value

Optional

Allowed keys: 

payload_json, custom_output, download, filename, files, retry_wait, retry_count, and response_type

Example Request

[
  {
    "method": "GET",
    "endpoint": "/network",
    "extra_fields": {},
    "query_params": {}
  }
]