Skip to main content

Cyware Orchestrate

Fortinet Fortigate

App Vendor: Fortinet

App Category: Network Security

App Version in Orchestrate: 2.2.1

API version: v1

About App

Fortinet Fortigate is a next-generation firewall that supports packet filtering, IPSec, SSL VPNs, network monitoring, IP mapping, and content inspection. The Fortinet Fortigate app allows security teams to integrate with the Fortinet Fortigate enterprise application to utilize the deep inspection capabilities to identify threats and block them. It provides the ability to remove blind spots with SSL inspection, automate threat protection, share threat intelligence across the entire digital attack, and offers robust protection from known and unknown attacks.

The Fortinet Fortigate app in the Orchestrate application performs the following actions:

Action

Description

Create Address Group

This action creates an address group which includes the address objects.

Create Address Object

This action creates a new address object.

Get Address Group by Name

This action fetches information about an address group based on the address group name.

Get All Address Objects

This action fetches all the address objects in the environment.

Get Address Object by Name

This action fetches information about an address object based on the address object name.

Update Address Group

This action adds or removes an address object to the address group based on the address group name.

Update Address Object

This action updates an existing address object with the provided data such as IP address or IP range.

Delete Address Object

This action deletes a network address object.

Configuration Parameters

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

Parameter

Description

Field Type

Required/Optional

Comments

API Key

Enter the API key created using the Fortigate CLI.

Password

Required

Vdom

Enter the name of the virtual domain to connect.

Example:

"root"

Text

Required

Default value:

root

Verify

Select whether to perform the SSL certificate verification.

Text

Required

Default value:

false

Allowed values:

  • true

  • false

Endpoint URL

Enter the URL of the Fortigate host.

Example:

"http[s]://<fortigate-host>/"

Text

Required

Action: Create Address Group

This action creates an address group which includes the address objects with the given name.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Group Name

Name of the address group to create.

Text

Required

Address Object Name

Name of the address object to add to the newly created address group.

Text

Required

Example Request

[
    {
        "address_name": "new-object-06-21-205118-0",
        "address_group_name": "new-object-06-21-205118-3"
    }
]
Action: Create Address Object

This action creates a new address object.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Object Name

Name of the address object to create.

Text

Required

You can also pass additional parameters to create an address object such as Object Type, IP address, Subnet, Start of IP Range, End of IP Range, and Fully Qualified Domain Name.

  • For an "ipmask" object type, it is mandatory to enter the IP address.

  • For an "iprange" object type, it is mandatory to enter the start and end of IP range.

  • For an "fqdn" object type, it is mandatory to enter the fully qualified domain name.

Example Request

[
    {
        "address_name": "new-object-06-21-205118-2",
    }
]
Action: Get Address Group By Name

This action fetches information about an address group based on the address group name.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Group Name

Name of the address group using which you can retrieve the address group details.

Text

Required

Example Request

[
    {
        "address_group_name": "new-object-06-21-205118-3"
    }
]
Action: Get All Address Objects

This action fetches all the address objects in the environment.

Action Input Parameters

This action does not require any input parameters.

Action: Get Address Object By Name

This action fetches information about an address object based on the address object name.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Object Name

Name of the address object to retrieve using which you can retrieve the address object details.

Text

Required

Example Request

[
    {
        "address_name": "new-object-06-21-205118-0
    }
]
Action: Update Address Group

This action adds or removes an address object to the address group based on the address group name.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Group

Name of the address group to update.

Text

Required

Want to Remove

Choose true to remove the address data.

Boolean

Required

Allowed values:

  • true

  • false

Address Name

Name of address object to add to or remove from address group.

Text

Optional

Example Request

[
    {
        "address_group_name": "new-object-06-21-205118-0",
        "remove": true,
        "address_name": "new-object-06-21-205118-3"
    }
]
Action: Update Address Object

This action updates an existing address object with the provided data such as IP address or IP range.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Object Name

Name of the address object to update.

Example:

"new-object-06-21-205118-3"

Text

Required

You can also pass additional parameters to the action such as Object Type, IP address, Subnet, Start of IP Range, End of IP Range, and Fully Qualified Domain Name.

Example Request

[
    {
        "ip_address": "44.33.22.11",
        "address_name": "new-object-06-21-205118-0"
    }
]
Action: Delete Address Object

This action deletes a network address object.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Address Object Name

Enter the name of a network address object that you need to delete.

Example:

"new-object-06-21-205118-3"

Text

Required

Example Request

[
    {
        "object_name": "new-object-06-21-205118-0"
    }
]