Fortinet FortiManager

Fortinet FortiManager is a centralized management solution for administering Fortinet security devices and policies.

Fortinet FortiManager is a centralized management platform for Fortinet security devices, providing comprehensive control over network security policies and configurations. This connector enables seamless integration with Swimlane Turbine, allowing users to automate firewall configurations, manage domain filters, and control access policies efficiently. By leveraging this integration, Swimlane Turbine users can enhance their security posture, streamline operations, and reduce manual intervention in managing network security.

Limitations

FortiManager allows to install pending network and system settings changes only!

It means that no pending security settings changes (like new/edited objects or policies) will be pushed down to managed devices during the Install Device Settings operation.

Supported Version

FortiManager is installing both Pending device settings and Pending security settings.

Configuration

Prerequisites

Before you can use the Fortinet FortiManager connector for Turbine, you'll need access to the Fortinet FortiManager API. This requires the following:

an API key authentication using the following parameters:

URL: The endpoint URL for accessing the FortiManager API.

API Key Token: A valid API key token for authenticating requests to the FortiManager API.

Authentication Methods

API Key Authentication

Setup Instructions:

The API key (or token) is obtained by:

Defining an API user in FortiManager GUI or CLI. An API user is a normal FortiManager user with the user_type attribute set to api.

Generating the API key using the FortiManager GUI or CLI:

Use the following FortiManager CLI command:

execute api-user generate-key api_001

It will return the API key:

New API key: 33fzwixxxxxxxxxxxmg1to9p8wbi

The generated API key is permanent (i.e., never expires).

However, you can renew it whenever you want using the FortiManager GUI.

You can now interact with the FortiManager JSON RPC API without issuing an explicit login (or logout) operation.

Document reference: https://how-to-fortimanager-api.readthedocs.io/en/latest/001_fmg_json_api_introduction.html#token-based-authentication

Troubleshoot Tips

You can renew API Key whenever you want using the FortiManager GUI.

Capabilities

Add Domain Filter

Block File Hash

Create Firewall Address Group

Create Firewall Address and Block IP

Create Firewall IPV6 Address

Create Firewall IPV6 Address Group

Create Firewall Wildcard FQDN

Delete Firewall Address

Delete Firewall Address Group

Delete Firewall IPV6 Address

Delete Firewall IPV6 Address Group

Delete Firewall Wildcard FQDN

Get Domain Filter

Get Firewall Address

Get Firewall Address Group ... and so on

Add Domain Filter

Use this API Document and choose the API /pm/config/adom//obj/dnsfilter/domain-filter (add) to find the parameters details. URL Format: /pm/config/adom//obj/dnsfilter/domain-filter.

Block File Hash

Use this API Document and choose the API /pm/config/adom//obj/ips/custom (add) to find the parameters details. URL Format: /pm/config/adom//obj/ips/custom .

Create Firewall Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp (add) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp.

Create Firewall Address and Block IP

Use this API Document and choose the API /pm/config/adom//obj/firewall/address (add) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address.

Create Firewall IPV6 Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address6 (add) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address6.

Create Firewall IPV6 Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp6 (add) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp6.

Create Firewall Wildcard FQDN

Use this API Document and choose the API /pm/config/adom//obj/firewall/wildcard-fqdn/custom (add) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/wildcard-fqdn/custom.

Delete Firewall Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address/ (delete) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address/.

Delete Firewall Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp/ (delete) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp/.

Delete Firewall IPV6 Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address6/ (delete) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address6/.

Delete Firewall IPV6 Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp6/ (delete) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp6/.

Delete Firewall Wildcard FQDN

Use this API Document and choose the API /pm/config/adom//obj/firewall/wildcard-fqdn/custom (delete) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/wildcard-fqdn/custom/.

Get Domain Filter

Use this API Document and choose the API /pm/config/adom//obj/dnsfilter/domain-filter (get) to find the parameters details. URL Format: /pm/config/adom//obj/dnsfilter/domain-filter.

Get Firewall Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address/ (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address/.

Get Firewall Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp/ (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp/.

Get Firewall Entries

Use this API Document and choose the API /pm/config/adom//obj/firewall/address/ (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address/.

Get Firewall IPV6 Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address6/ (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address/.

Get Firewall IPV6 Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp6/ (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp6/.

Get Firewall Wildcard FQDN

Use this API Document and choose the API /pm/config/adom//obj/firewall/wildcard-fqdn/custom (get) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/wildcard-fqdn/custom/.

Update Firewall Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address/ (update) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address/.

Update Firewall Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp/ (update) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp/.

Update Firewall IPV6 Address

Use this API Document and choose the API /pm/config/adom//obj/firewall/address6/ (update) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/address6/.

Update Firewall IPV6 Address Group

Use this API Document and choose the API /pm/config/adom//obj/firewall/addrgrp6/ (update) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/addrgrp6/.

Update Firewall Wildcard FQDN

Use this API Document and choose the API /pm/config/adom//obj/firewall/wildcard-fqdn/custom (update) to find the parameters details. URL Format: /pm/config/adom//obj/firewall/wildcard-fqdn/custom/.

Additional Documentation

Fortinet FortiManager Connector Documentation

Fortinet FortiManager API Documentation

Configurations

Fortinet FortiManager API Key Authentication

Authenticates using an API Key.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
apikey	API Key Token.	string	Required
verify_ssl	Verify SSL certificate.	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Add Domain Filter

Create a new domain filter in Fortinet FortiManager using the provided administrative domain (adom) parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method to be used.
params	array	Optional	List of Parameter Objects.
params.data	array	Optional	List of Domain Filter Data.
params.data.comment	string	Optional	Optional Comments.
params.data.entries	array	Optional	Domain Filter Entries.
params.data.entries.action	string	Optional	Action for Domain Filter Matches.
params.data.entries.domain	string	Optional	Domain Entries to be filtered.
params.data.entries.id	number	Optional	Identifier for the Entry.
params.data.entries.status	string	Optional	Enable or disable Domain Filter.
params.data.entries.type	string	Optional	DNS Domain Filter Type.
params.data.id	number	Optional	Identifier for the Data Object.
params.data.name	string	Optional	Name of the Domain Filter Table.
params.url	string	Optional	URL for the Domain Filter. URL Format should be /pm/config/adom//obj/dnsfilter/domain-filter. Replace with the administrative domain name.
session	string	Optional	Session Identifier.
id	number	Optional	Identifier for the Request.

Input Example

{"json_body":{"method":"add","params":[{"data":[{"comment":" ","entries":[{"action":"block","domain":" ","id":0,"status":"disable","type":"simple"}],"id":0,"name":" "}],"url":"/pm/config/adom/{adom}/obj/dnsfilter/domain-filter"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.id	number	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

{"status_code":200,"response_headers":{"connection":"Keep-Alive","content-length":65,"content-type":"text/html; charset=iso-8859-1 ","date":"Thu,07 Nov 2024 08:04:44 GMT","keep-alive":"timeout=5,max=100","permissions-policy":"geolocation=(self),microphone=()","referrer-policy":"no-referrer-when-downgrade","server":"Apache/2.4.41 (Ubuntu)","strict-transport-security":"max-age=31536000; includeSubDomains; preload","x-content-type-options":"nosniff","x-frame-options":"SAMEORIGIN"},"reason":"OK","js...

Block File Hash

Block a specified file hash across the network using Fortinet FortiManager. Requires 'adom' as a path parameter and JSON body input.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP method to use
params	array	Optional	Parameter for Block File Hash
params.data	array	Optional	Response data
params.data.action	string	Optional	Default action (pass or block) for this signature.
params.data.application	array	Optional	Applications to be protected. Blank for all applications.
params.data.comment	string	Optional	Comment.
params.data.location	array	Optional	Protect client or server traffic.
params.data.log	string	Optional	Enable/disable logging.
params.data.log-packet	string	Optional	Enable/disable packet logging.
params.data.os	array	Optional	Operating System(s) that the signature protects. Blank for all operating systems.
params.data.protocol	string	Optional	Protocol(s) that the signature scans. Blank for all protocols.
params.data.rule-id	number	Optional	Response data
params.data.severity	string	Optional	Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
params.data.sig-name	string	Optional	Signature name.
params.data.signature	string	Optional	Custom signature enclosed in single quotes.
params.data.status	string	Optional	Enable/disable this signature.
params.data.tag	string	Optional	Signature tag.
params.url	string	Optional	URL for the Domain Filter. URL Format should be /pm/config/adom//obj/ips/custom. Replace with the ADOM name.
session	string	Optional	Session ID.
id	number	Optional	ID.

Input Example

{"json_body":{"method":"add","params":[{"data":[{"action":"block","application":[" "],"comment":" ","location":[" "],"log":"disable","log-packet":"disable","os":[" "],"protocol":" ","rule-id":0,"severity":" ","sig-name":" ","signature":" ","status":"disable","tag":" "}],"url":"/pm/config/adom/{adom}/obj/ips/custom"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.tag	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Create Firewall Address and Block IP

Add a new firewall address object and block an IP within a specified ADOM in Fortinet FortiManager using provided JSON body data.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform.
session	string	Optional	Session ID.
id	string	Optional	ID of the Address.
params	array	Optional	List of Parameter Objects.
params.url	string	Optional	URL of the API endpoint. The URL should be in the format /pm/config/adom//obj/firewall/address. Replace with the ADOM name.
params.data	array	Optional	List of address Objects.
params.data._image-base64	string	Optional	Base64 Encoded Image.
params.data.allow-routing	string	Optional	Enable or disable Routing.
params.data.associated-interface	array	Optional	Network Interface associated with Address.
params.data.cache-ttl	number	Optional	Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
params.data.clearpass-spt	string	Optional	SPT (System Posture Token) value.
params.data.color	number	Optional	Color of Icon on GUI.
params.data.comment	string	Optional	Comment.
params.data.country	array	Optional	IP addresses associated to a Country.
params.data.dirty	string	Optional	To be deleted address.
params.data.dynamic_mapping	array	Optional	List of dynamic Mappings.
params.data.dynamic_mapping._image-base64	string	Optional	Base64 Encoded Image.
params.data.dynamic_mapping._scope	array	Optional	Scope of the Mapping.
params.data.dynamic_mapping._scope.name	string	Optional	Name of the Scope.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM of the Scope.
params.data.dynamic_mapping.allow-routing	string	Optional	Enable/disable use of this address in routing configurations.
params.data.dynamic_mapping.associated-interface	string	Optional	Network interface associated with address.
params.data.dynamic_mapping.cache-ttl	number	Optional	Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
params.data.dynamic_mapping.clearpass-spt	string	Optional	SPT (System Posture Token) value.
params.data.dynamic_mapping.color	number	Optional	Color of Icon on GUI.

Input Example

{"json_body":{"method":"add","params":[{"data":[{"_image-base64":" ","allow-routing":"disable","associated-interface":[" "],"cache-ttl":0,"clearpass-spt":"unknown","color":0,"comment":" ","country":[" "],"dirty":"dirty","dynamic_mapping":[{"_image-base64":" ","_scope":[{"name":" ","vdom":" "}],"allow-routing":"disable","associated-interface":" ","cache-ttl":0,"clearpass-spt":"unknown","color":0,"comment":" ","country":[" "],"dirty":"dirty","end-ip":" ","end-mac":" ","epg-name":" ","fabric-object":"disable","filter":" ","fqdn":" ","fsso-group":[" "],"global-object":0,"hw-model":" ","hw-vendor":" ","interface":" ","macaddr":[" "],"node-ip-only":"disable","obj-id":" ","obj-tag":" ","obj-type":"ip","organization":" ","os":" ","pattern-end":0,"pattern-start":0,"policy-group":" ","route-tag":0,"sdn":[" "],"sdn-addr-type":"private","sdn-tag":" ","start-ip":" ","start-mac":" ","sub-type":"sdn","subnet":[" "],"subnet-name":" ","sw-version":" ","tag-detection-level":" ","tag-type":" ","tags":[" "],"tenant":" ","type":"ipmask","url":" ","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","visibility":"disable","wildcard":[" "],"wildcard-fqdn":" "}],"end-ip":" ","epg-name":" ","fabric-object":"disable","filter":" ","fqdn":" ","fsso-group":[" "],"hw-model":" ","hw-vendor":" ","interface":[" "],"list":[{"ip":" ","net-id":" ","obj-id":" "}],"macaddr":[" "],"name":" ","node-ip-only":"disable","obj-id":" ","obj-tag":" ","obj-type":"ip","organization":" ","os":" ","policy-group":" ","route-tag":0,"sdn":[" "],"sdn-addr-type":"private","sdn-tag":" ","start-ip":" ","sub-type":"sdn","subnet":[" "],"subnet-name":" ","sw-version":" ","tag-detection-level":" ","tag-type":" ","tagging":[{"category":[" "],"name":" ","tags":[" "]}],"tenant":" ","type":"ipmask","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","wildcard":[" "],"wildcard-fqdn":" "}],"url":"/pm/config/adom/{adom}/obj/firewall/address"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Create Firewall Address Group

Add a new address group to the firewall configuration in Fortinet FortiManager. Requires 'json_body' with details.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform.
session	string	Optional	Session ID.
id	string	Optional	ID of the Address Group.
params	array	Optional	List of Parameter Objects.
params.data	array	Optional	List of Address Group Objects.
params.data._image-base64	string	Optional	Base64 Encoded Image.
params.data.allow-routing	string	Optional	Enable or disable Routing.
params.data.category	string	Optional	Address Group Category.
params.data.color	number	Optional	Color of Icon on GUI. $unsigned int32 to be used.
params.data.comment	string	Optional	Comment for the Address Group.
params.data.dynamic_mapping	array	Optional	List of dynamic Mapping Objects.
params.data.dynamic_mapping._image-base64	string	Optional	Base64 Encoded Image.
params.data.dynamic_mapping._scope	array	Optional	List of Scope Objects.
params.data.dynamic_mapping._scope.name	string	Optional	Scope Name.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM Name.
params.data.dynamic_mapping.allow-routing	string	Optional	Enable or disable Routing.
params.data.dynamic_mapping.category	string	Optional	Address Group Category.
params.data.dynamic_mapping.color	number	Optional	Color of Icon on GUI.
params.data.dynamic_mapping.comment	string	Optional	Comment for the Address Group.
params.data.dynamic_mapping.exclude	string	Optional	Enable or disable Exclusion.
params.data.dynamic_mapping.exclude-member	array	Optional	List of Exclusion Members.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object.
params.data.dynamic_mapping.global-object	number	Optional	Global Object setting.
params.data.dynamic_mapping.member	array	Optional	Support meta variable Address objects contained within the group.
params.data.dynamic_mapping.tags	array	Optional	List of Tags.

Input Example

{"json_body":{"method":"add","params":[{"data":[{"_image-base64":" ","allow-routing":"disable","category":"default","color":0,"comment":" ","dynamic_mapping":[{"_image-base64":" ","_scope":[{"name":" ","vdom":" "}],"allow-routing":"disable","category":"default","color":0,"comment":" ","exclude":"disable","exclude-member":[" "],"fabric-object":"disable","global-object":0,"member":[" "],"tags":[" "],"type":"default","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","visibility":"disable"}],"exclude":"disable","exclude-member":[" "],"fabric-object":"disable","member":[" "],"name":" ","tagging":[{"category":[" "],"name":" ","tags":[" "]}],"type":"default","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"url":"/pm/config/adom/{adom}/obj/firewall/addrgrp"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Create Firewall IPv6 Address

Add a new IPv6 address object to the Fortinet FortiManager firewall. Requires 'adom' as a path parameter and details in the JSON body.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform Action.
params	array	Optional	List of Parameter Objects.
params.data	array	Optional	List of Data Objects.
params.data._image-base64	string	Optional	Response data
params.data.cache-ttl	number	Optional	Minimal TTL of individual IPv6 addresses in FQDN cache.
params.data.color	number	Optional	Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
params.data.comment	string	Optional	Comment for the Address.
params.data.country	array	Optional	IPv6 Addresses for specific Country.
params.data.dynamic_mapping	array	Optional	Dynamic Mapping Details.
params.data.dynamic_mapping._image-base64	string	Optional	Response data
params.data.dynamic_mapping._scope	array	Optional	Scope Details.
params.data.dynamic_mapping._scope.name	string	Optional	Scope Name.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM Name.
params.data.dynamic_mapping.cache-ttl	number	Optional	Minimal TTL of individual IPv6 addresses in FQDN cache.
params.data.dynamic_mapping.color	number	Optional	Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
params.data.dynamic_mapping.comment	string	Optional	Comment for the Address.
params.data.dynamic_mapping.country	array	Optional	IPv6 Addresses for specific Country.
params.data.dynamic_mapping.end-ip	string	Optional	Final IP address (inclusive) in the range for the address (format - xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
params.data.dynamic_mapping.end-mac	string	Optional	Final MAC Address in Range.
params.data.dynamic_mapping.epg-name	string	Optional	Endpoint Group Name.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object setting.
params.data.dynamic_mapping.fqdn	string	Optional	Fully qualified Domain Name.
params.data.dynamic_mapping.global-object	number	Optional	Global Object setting.
params.data.dynamic_mapping.host	string	Optional	Host IPv6 Address.
params.data.dynamic_mapping.host-type	string	Optional	Host Type.

Input Example

{"method":"string","params":[{"data":[{"_image-base64":"string","cache-ttl":123,"color":123,"comment":"string","country":["string"],"dynamic_mapping":[{"_image-base64":"string","_scope":[],"cache-ttl":123,"color":123,"comment":"string","country":["string"],"end-ip":"string","end-mac":"string","epg-name":"Example Name","fabric-object":"string","fqdn":"string","global-object":123,"host":"string","host-type":"string","ip6":"string","macaddr":["string"],"obj-id":"string","route-tag":123,"sdn":["string"],"sdn-tag":"string","start-ip":"string","start-mac":"string","subnet-segment":[],"tags":["string"],"template":["string"],"tenant":"string","type":"ipprefix","uuid":"12345678-1234-1234-1234-123456789abc","visibility":"string"}],"end-ip":"string","epg-name":"Example Name","fabric-object":"string","fqdn":"string","host":"string","host-type":"string","ip6":"string","list":[{"ip":"string","net-id":"string","obj-id":"string"}],"macaddr":["string"],"name":"Example Name","obj-id":"string","route-tag":123,"sdn":["string"],"sdn-tag":"string","start-ip":"string","subnet-segment":[{"name":"Example Name","type":"string","value":"string"}],"tagging":[{"category":["string"],"name":"Example Name","tags":["string"]}],"template":["string"],"tenant":"string","type":"ipprefix","uuid":"12345678-1234-1234-1234-123456789abc"}],"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{"method":"add","result":[{}],"id":1}}

Create Firewall IPv6 Address Group

Create a new IPv6 address group in a specified ADOM on Fortinet FortiManager. Requires mandatory URL and Method fields.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform Action.
params	array	Optional	List of Parameter Objects.
params.data	array	Optional	List of Data Objects.
params.data._image-base64	string	Optional	Response data
params.data.color	number	Optional	Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets the value to 1).
params.data.comment	string	Optional	Comment for the Address Group.
params.data.dynamic_mapping	array	Optional	List of dynamic Mapping Objects.
params.data.dynamic_mapping._image-base64	string	Optional	Response data
params.data.dynamic_mapping._scope	array	Optional	List of Scope Objects.
params.data.dynamic_mapping._scope.name	string	Optional	Scope Name.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM Name.
params.data.dynamic_mapping.color	number	Optional	Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets the value to 1).
params.data.dynamic_mapping.comment	string	Optional	Comment for dynamic Mapping.
params.data.dynamic_mapping.exclude	string	Optional	Enable or disable Exclusion.
params.data.dynamic_mapping.exclude-member	array	Optional	List of Exclusion Members.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object setting.
params.data.dynamic_mapping.global-object	number	Optional	Global Object Identifier.
params.data.dynamic_mapping.member	array	Optional	List of address Objects.
params.data.dynamic_mapping.tags	array	Optional	List of Tags.
params.data.dynamic_mapping.uuid	string	Optional	Universally Unique Identifier.
params.data.dynamic_mapping.visibility	string	Optional	Visibility Setting.
params.data.exclude	string	Optional	Enable or disable Exclusion.
params.data.exclude-member	array	Optional	List of Exclusion Members.
params.data.fabric-object	string	Optional	Security Fabric global Object setting.
params.data.member	array	Optional	List of address Objects.

Input Example

{"method":"string","params":[{"data":[{"_image-base64":"string","color":123,"comment":"string","dynamic_mapping":[{"_image-base64":"string","_scope":[],"color":123,"comment":"string","exclude":"string","exclude-member":["string"],"fabric-object":"string","global-object":123,"member":["string"],"tags":["string"],"uuid":"12345678-1234-1234-1234-123456789abc","visibility":"string"}],"exclude":"string","exclude-member":["string"],"fabric-object":"string","member":["string"],"name":"Example Name","tagging":[{"category":["string"],"name":"Example Name","tags":["string"]}],"uuid":"12345678-1234-1234-1234-123456789abc"}],"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{"method":"add","result":[{}],"id":1}}

Create Firewall Wildcard FQDN

Add a new Wildcard FQDN to the specified ADOM in Fortinet FortiManager firewall configuration. Requires a JSON body input.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method to be used.
params	array	Optional	List of Parameter Objects.
params.data	array	Optional	List of Data Objects.
params.data.color	number	Optional	GUI Icon Color Identifier.
params.data.comment	string	Optional	Comment for the Entry.
params.data.name	string	Optional	Address Name for the Entry.
params.data.uuid	string	Optional	Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
params.data.wildcard-fqdn	string	Optional	Wildcard FQDN for the Entry.
params.url	string	Optional	URL for the Request. URL should be in the format /pm/config/adom//obj/firewall/wildcard-fqdn/custom. Replace with the ADOM name.
session	string	Optional	Session Identifier for the Request.
id	number	Optional	Identifier for the Request.

Input Example

{"method":"string","params":[{"data":[{"color":123,"comment":"string","name":"Example Name","uuid":"12345678-1234-1234-1234-123456789abc","wildcard-fqdn":"string"}],"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Delete Firewall Address

Remove a specified firewall address from Fortinet FortiManager using 'adom' and 'address' identifiers provided in the JSON body.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.url	string	Optional	URL for the delete Request. URL format should be /pm/config/adom//obj/firewall/address/. Replace and with actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"json_body":{"method":"delete","params":[{"url":"/pm/config/adom/{adom}/obj/firewall/address/{address}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Delete Firewall Address Group

Remove a specified address group from the firewall configuration in Fortinet FortiManager using 'adom' and 'addrgrp' as path parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of URL Parameters.
params.url	string	Optional	URL Path Parameter. URL format should be like /pm/config/adom//obj/firewall/addrgrp/. Replace and with actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Request Identifier.

Input Example

{"method":"string","params":[{"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Delete Firewall IPv6 Address

Remove a specified IPv6 address object from a FortiManager ADOM using 'adom' and 'address6' path parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method to be used.
params	array	Optional	List of URL Parameters.
params.url	string	Optional	URL Path Parameter. URL should be in the format: /pm/config/adom//obj/firewall/address6/. Replace the and with the actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"method":"string","params":[{"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{"method":"delete","result":[{}],"id":1}}

Delete Firewall IPv6 Address Group

Remove a specified IPv6 address group from the Fortinet FortiManager firewall configuration. Requires JSON body input.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.url	string	Optional	URL Path for the Request. This URL path should be in the format /pm/config/adom//obj/firewall/addrgrp6/. Replace and with actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"method":"string","params":[{"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Delete Firewall Wildcard FQDN

Remove a specified Custom Wildcard FQDN from the Firewall Configuration in Fortinet FortiManager. Requires 'adom' and 'custom' path parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of URL Parameters.
params.url	string	Optional	URL Path for the Request. The URL should be in the format: /pm/config/adom//obj/firewall/wildcard-fqdn/custom/. Replace the and with the actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"json_body":{"method":"delete","params":[{"url":"/pm/config/adom/{adom}/obj/firewall/wildcard-fqdn/custom/{custom}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Get Domain Filter

Retrieve domain filter settings from Fortinet FortiManager for a specified administrative domain. Requires JSON body input.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method to perform.
params	array	Optional	List of Parameter Objects.
params.attr	string	Optional	The name of the attribute to retrieve its datasource. Only used with datasrc option.
params.fields	array	Optional	Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
params.filter	array	Optional	Filter the result according to a set of criteria.
params.get_used	number	Optional	Return used Objects Flag.
params.loadsub	number	Optional	Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
params.option	string	Optional	Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned.
params.range	array	Optional	Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a matching result.
params.sortings	array	Optional	Specify the sorting of the returned result.
params.url	string	Optional	URL to perform the action. The URL should be in the format /pm/config/adom//obj/dnsfilter/domain-filter. Replace with the administrative domain name.
session	string	Optional	Session Identifier.
id	number	Optional	Request Identifier.

Input Example

{"json_body":{"method":"get","params":[{"attr":"string","fields":[["{attribute}"]],"filter":[["{attribute}","==","{value}"]],"get used":0,"loadsub":0,"option":"{option}","range":[[2,5]],"sortings":[{"{attribute}":1}],"url":"/pm/config/adom/{adom}/obj/dnsfilter/domain-filter"}],"session":"string","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	array	Response data
result.data.comment	string	Response data
result.data.entries	array	Response data
result.data.entries.action	string	Response data
result.data.entries.domain	string	Response data
result.data.entries.id	number	Response data
result.data.entries.status	string	Response data
result.data.entries.type	string	Response data
result.data.id	number	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Get Firewall Address

Retrieve details of a specific firewall address in Fortinet FortiManager using the administrative domain (adom) and address name.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Set fetch option for the request. If no option is specified, by default the attributes of the object will be returned.
params.url	string	Optional	URL of the request. The URL should be in the format of /pm/config/adom//obj/firewall/address/. Replace and with the actual administrative domain and address name.
session	string	Optional	Session Identifier String.
id	number	Optional	Identifier for the Request.

Input Example

{"json_body":{"method":"get","params":[{"option":" ","url":"/pm/config/adom/{adom}/obj/firewall/address/{address}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data._image-base64	string	Response data
result.data.allow-routing	string	Response data
result.data.associated-interface	array	Response data
result.data.cache-ttl	number	Response data
result.data.clearpass-spt	string	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.country	array	Response data
result.data.dirty	string	Response data
result.data.dynamic_mapping	array	Response data
result.data.dynamic_mapping._image-base64	string	Response data
result.data.dynamic_mapping._scope	array	Response data
result.data.dynamic_mapping._scope.name	string	Response data
result.data.dynamic_mapping._scope.vdom	string	Response data
result.data.dynamic_mapping.allow-routing	string	Response data
result.data.dynamic_mapping.associated-interface	string	Response data
result.data.dynamic_mapping.cache-ttl	number	Response data
result.data.dynamic_mapping.clearpass-spt	string	Response data
result.data.dynamic_mapping.color	number	Response data
result.data.dynamic_mapping.comment	string	Response data

Output Example

Get Firewall Address Group

Retrieve details of a specific Firewall Address Group in Fortinet FortiManager using required 'adom' and 'addrgrp' parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Set fetch option for the request. If no option is specified, by default the attributes of the object will be returned.
params.url	string	Optional	URL of the object to be fetched. The URL should be in the format /pm/config/adom//obj/firewall/addrgrp/. Replace and with the appropriate values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"json_body":{"method":"get","params":[{"option":"chksum","url":"/pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data._image-base64	string	Response data
result.data.allow-routing	string	Response data
result.data.category	string	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.dynamic_mapping	array	Response data
result.data.dynamic_mapping._image-base64	string	Response data
result.data.dynamic_mapping._scope	array	Response data
result.data.dynamic_mapping._scope.name	string	Response data
result.data.dynamic_mapping._scope.vdom	string	Response data
result.data.dynamic_mapping.allow-routing	string	Response data
result.data.dynamic_mapping.category	string	Response data
result.data.dynamic_mapping.color	number	Response data
result.data.dynamic_mapping.comment	string	Response data
result.data.dynamic_mapping.exclude	string	Response data
result.data.dynamic_mapping.exclude-member	array	Response data
result.data.dynamic_mapping.fabric-object	string	Response data
result.data.dynamic_mapping.global-object	number	Response data
result.data.dynamic_mapping.member	array	Response data
result.data.dynamic_mapping.tags	array	Response data

Output Example

Get Firewall Entries

Retrieve firewall address entries from FortiManager using specified administrative domain and parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Fetch Option for the Request.
params.url	string	Optional	URL for the Request. The URL should be in the format of /pm/config/adom//obj/firewall/address/. Replace and with the actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"json_body":{"method":"get","params":[{"option":"{option}","url":"/pm/config/adom/{adom}/obj/firewall/address/{address}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data._image-base64	string	Response data
result.data.allow-routing	string	Response data
result.data.associated-interface	array	Response data
result.data.cache-ttl	number	Response data
result.data.clearpass-spt	string	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.country	array	Response data
result.data.dirty	string	Response data
result.data.dynamic_mapping	array	Response data
result.data.dynamic_mapping._image-base64	string	Response data
result.data.dynamic_mapping._scope	array	Response data
result.data.dynamic_mapping._scope.name	string	Response data
result.data.dynamic_mapping._scope.vdom	string	Response data
result.data.dynamic_mapping.allow-routing	string	Response data
result.data.dynamic_mapping.associated-interface	string	Response data
result.data.dynamic_mapping.cache-ttl	number	Response data
result.data.dynamic_mapping.clearpass-spt	string	Response data
result.data.dynamic_mapping.color	number	Response data
result.data.dynamic_mapping.comment	string	Response data

Output Example

Get Firewall IPv6 Address

Retrieve details of a specific IPv6 address within the firewall configuration on Fortinet FortiManager, requiring 'adom' and 'address6' path parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Fetch Option for the Request. Set fetch option for the request. If no option is specified, by default the attributes of the object will be returned. The possible values are scope member, chksum, datasrc. scope member - Return a list of scope members along with other attributes. chksum - Return the check-sum value instead of attributes. datasrc - Return all objects that can be referenced by an attribute. Require attr parameter.
params.url	string	Optional	URL for the Request. The URL should be in the format /pm/config/adom//obj/firewall/address/. Replace and with the actual values.
session	string	Optional	Session Identifier.
id	number	Optional	Identifier for the Request.

Input Example

{"method":"string","params":[{"option":"string","url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data._image-base64	string	Response data
result.data.allow-routing	string	Response data
result.data.associated-interface	array	Response data
result.data.cache-ttl	number	Response data
result.data.clearpass-spt	string	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.country	array	Response data
result.data.dirty	string	Response data
result.data.dynamic_mapping	array	Response data
result.data.dynamic_mapping._image-base64	string	Response data
result.data.dynamic_mapping._scope	array	Response data
result.data.dynamic_mapping._scope.name	string	Response data
result.data.dynamic_mapping._scope.vdom	string	Response data
result.data.dynamic_mapping.allow-routing	string	Response data
result.data.dynamic_mapping.associated-interface	string	Response data
result.data.dynamic_mapping.cache-ttl	number	Response data
result.data.dynamic_mapping.clearpass-spt	string	Response data
result.data.dynamic_mapping.color	number	Response data
result.data.dynamic_mapping.comment	string	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{"method":"get","result":[{}],"id":1}}

Get Firewall IPv6 Address Group

Retrieve details of a specific IPv6 address group in Fortinet FortiManager using 'adom' and 'addrgrp6' identifiers.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Fetch Option for the Request. Set fetch option for the request. If no option is specified, by default the attributes of the object will be returned. The possible values are scope member, chksum, datasrc. scope member - Return a list of scope members along with other attributes. chksum - Return the check-sum value instead of attributes. datasrc - Return all objects that can be referenced by an attribute. Require attr parameter.
params.url	string	Optional	URL for the Request. The URL should be in the format /pm/config/adom//obj/firewall/addrgrp6/. Replace and with the actual values.
session	string	Optional	Session Identifier String.
id	number	Optional	Unique Identifier for the Request.

Input Example

{"method":"string","params":[{"option":"string","url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data._image-base64	string	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.dynamic_mapping	array	Response data
result.data.dynamic_mapping._image-base64	string	Response data
result.data.dynamic_mapping._scope	array	Response data
result.data.dynamic_mapping._scope.name	string	Response data
result.data.dynamic_mapping._scope.vdom	string	Response data
result.data.dynamic_mapping.color	number	Response data
result.data.dynamic_mapping.comment	string	Response data
result.data.dynamic_mapping.exclude	string	Response data
result.data.dynamic_mapping.exclude-member	array	Response data
result.data.dynamic_mapping.fabric-object	string	Response data
result.data.dynamic_mapping.global-object	number	Response data
result.data.dynamic_mapping.member	array	Response data
result.data.dynamic_mapping.tags	array	Response data
result.data.dynamic_mapping.uuid	string	Response data
result.data.dynamic_mapping.visibility	string	Response data
result.data.exclude	string	Response data
result.data.exclude-member	array	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{"method":"get","result":[{}],"id":1}}

Get Firewall Wildcard FQDN

Retrieve details of a specific wildcard FQDN in Fortinet FortiManager firewall, requiring 'adom' and 'custom' path parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	HTTP Method for the Request.
params	array	Optional	List of Parameter Objects.
params.option	string	Optional	Set fetch option for the request. If no option is specified, by default the attributes of the object will be returned.
params.url	string	Optional	URL of the object to be fetched. The URL should be in the format /pm/config/adom//obj/firewall/wildcard-fqdn/custom/. Replace and with the actual values.
session	string	Optional	Session Identifier.
id	number	Optional	Identifier for the Request.

Input Example

{"method":"string","params":[{"option":"string","url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.color	number	Response data
result.data.comment	string	Response data
result.data.name	string	Response data
result.data.uuid	string	Response data
result.data.wildcard-fqdn	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Update Firewall Address

Update an existing firewall address object within a specified ADOM on Fortinet FortiManager using provided JSON body data.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform.
params	array	Optional	List of Parameter Objects.
params.data	object	Optional	Data Object for Address.
params.data._image-base64	string	Optional	Base64 Encoded Image.
params.data.allow-routing	string	Optional	Enable or disable Routing.
params.data.associated-interface	array	Optional	Network Interface associated.
params.data.cache-ttl	number	Optional	Minimal TTL in Seconds.
params.data.clearpass-spt	string	Optional	System Posture Token Value.
params.data.color	number	Optional	Color of Icon on GUI.
params.data.comment	string	Optional	Comment.
params.data.country	array	Optional	IP Addresses for specific Country.
params.data.dirty	string	Optional	Address Deletion Status.
params.data.dynamic_mapping	array	Optional	Dynamic Mapping Details.
params.data.dynamic_mapping._scope	array	Optional	Scope Details.
params.data.dynamic_mapping._scope.name	string	Optional	Scope Name.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM Name.
params.data.dynamic_mapping.allow-routing	string	Optional	Enable or disable Routing.
params.data.dynamic_mapping.associated-interface	string	Optional	Network Interface associated.
params.data.dynamic_mapping.cache-ttl	number	Optional	Minimal TTL in Seconds.
params.data.dynamic_mapping.clearpass-spt	string	Optional	System Posture Token Value.
params.data.dynamic_mapping.color	number	Optional	Color of Icon on GUI.
params.data.dynamic_mapping.comment	string	Optional	Comment.
params.data.dynamic_mapping.country	array	Optional	IP Addresses for specific Country.
params.data.dynamic_mapping.dirty	string	Optional	Address Deletion Status.
params.data.dynamic_mapping.end-ip	string	Optional	Final IP Address in Range.

Input Example

{"json_body":{"method":"update","params":[{"data":{"_image-base64":" ","allow-routing":"disable","associated-interface":[" "],"cache-ttl":0,"clearpass-spt":"unknown","color":0,"comment":" ","country":[" "],"dirty":"dirty","dynamic_mapping":[{"_image-base64":" ","_scope":[{"name":" ","vdom":" "}],"allow-routing":"disable","associated-interface":" ","cache-ttl":0,"clearpass-spt":"unknown","color":0,"comment":" ","country":[" "],"dirty":"dirty","end-ip":" ","end-mac":" ","epg-name":" ","fabric-object":"disable","filter":" ","fqdn":" ","fsso-group":[" "],"global-object":0,"hw-model":" ","hw-vendor":" ","interface":" ","macaddr":[" "],"node-ip-only":"disable","obj-id":" ","obj-tag":" ","obj-type":"ip","organization":" ","os":" ","pattern-end":0,"pattern-start":0,"policy-group":" ","route-tag":0,"sdn":[" "],"sdn-addr-type":"private","sdn-tag":" ","start-ip":" ","start-mac":" ","sub-type":"sdn","subnet":[" "],"subnet-name":" ","sw-version":" ","tag-detection-level":" ","tag-type":" ","tags":[" "],"tenant":" ","type":"ipmask","url":" ","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","visibility":"disable","wildcard":[" "],"wildcard-fqdn":" "}],"end-ip":" ","epg-name":" ","fabric-object":"disable","filter":" ","fqdn":" ","fsso-group":[" "],"hw-model":" ","hw-vendor":" ","interface":[" "],"list":[{"ip":" ","net-id":" ","obj-id":" "}],"macaddr":[" "],"name":" ","node-ip-only":"disable","obj-id":" ","obj-tag":" ","obj-type":"ip","organization":" ","os":" ","policy-group":" ","route-tag":0,"sdn":[" "],"sdn-addr-type":"private","sdn-tag":" ","start-ip":" ","sub-type":"sdn","subnet":[" "],"subnet-name":" ","sw-version":" ","tag-detection-level":" ","tag-type":" ","tagging":[{"category":[" "],"name":" ","tags":[" "]}],"tenant":" ","type":"ipmask","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","wildcard":[" "],"wildcard-fqdn":" "},"url":"/pm/config/adom/{adom}/obj/firewall/address/{address}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Update Firewall Address Group

Update an existing Firewall Address Group in Fortinet FortiManager using a specified ADOM and identifier.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform on the Endpoint.
session	string	Optional	Session Identifier.
id	number	Optional	Identifier for the Request.
params	array	Optional	List of Parameter Objects.
params.data	object	Optional	Data Object containing Address Group Details.
params.data._image-base64	string	Optional	Response data
params.data.allow-routing	string	Optional	Enable or disable Routing Use.
params.data.category	string	Optional	Address Group Category.
params.data.color	number	Optional	Color of Icon on the GUI.
params.data.comment	string	Optional	Comment for the Address Group.
params.data.dynamic_mapping	array	Optional	List of dynamic Mapping Objects.
params.data.dynamic_mapping._image-base64	string	Optional	Response data
params.data.dynamic_mapping._scope	array	Optional	Scope of the dynamic Mapping.
params.data.dynamic_mapping._scope.name	string	Optional	Name of the Scope.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM of the Scope.
params.data.dynamic_mapping.allow-routing	string	Optional	Enable or disable Routing Use.
params.data.dynamic_mapping.category	string	Optional	Address Group Category.
params.data.dynamic_mapping.color	number	Optional	Color of Icon on the GUI.
params.data.dynamic_mapping.comment	string	Optional	Comment for the dynamic Mapping.
params.data.dynamic_mapping.exclude	string	Optional	Enable or disable Address Exclusion.
params.data.dynamic_mapping.exclude-member	array	Optional	Address Exclusion Members.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object setting.
params.data.dynamic_mapping.global-object	number	Optional	Global Object setting.
params.data.dynamic_mapping.member	array	Optional	Address Objects in the Group.
params.data.dynamic_mapping.tags	array	Optional	Tags for the dynamic Mapping.

Input Example

{"json_body":{"method":"update","params":[{"data":{"_image-base64":" ","allow-routing":"disable","category":"default","color":0,"comment":" ","dynamic_mapping":[{"_image-base64":" ","_scope":[{"name":" ","vdom":" "}],"allow-routing":"disable","category":"default","color":0,"comment":" ","exclude":"disable","exclude-member":[" "],"fabric-object":"disable","global-object":0,"member":[" "],"tags":[" "],"type":"default","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","visibility":"disable"}],"exclude":"disable","exclude-member":[" "],"fabric-object":"disable","member":[" "],"name":" ","tagging":[{"category":[" "],"name":" ","tags":[" "]}],"type":"default","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"url":"/pm/config/global/obj/firewall/addrgrp/{addrgrp}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Update Firewall IPv6 Address

Update an existing IPv6 address object in Fortinet FortiManager firewall within a specified ADOM and address6 using the required JSON body.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform.
params	array	Optional	Parameter for Update Firewall IPv6 Address
params.data	object	Optional	Response data
params.data._image-base64	string	Optional	Response data
params.data.cache-ttl	number	Optional	Minimal TTL of individual IPv6 addresses in FQDN cache.
params.data.color	number	Optional	Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
params.data.comment	string	Optional	Comment for the Address.
params.data.country	array	Optional	IPv6 Addresses for specific Country.
params.data.dynamic_mapping	array	Optional	Response data
params.data.dynamic_mapping._image-base64	string	Optional	Response data
params.data.dynamic_mapping._scope	array	Optional	Response data
params.data.dynamic_mapping._scope.name	string	Optional	Scope Name.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM Name.
params.data.dynamic_mapping.cache-ttl	number	Optional	Minimal TTL for IPv6 Addresses.
params.data.dynamic_mapping.color	number	Optional	Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
params.data.dynamic_mapping.comment	string	Optional	Comment for the Address.
params.data.dynamic_mapping.country	array	Optional	IPv6 Addresses for specific Country.
params.data.dynamic_mapping.end-ip	string	Optional	Final IP Address in Range.
params.data.dynamic_mapping.end-mac	string	Optional	Final MAC Address in Range.
params.data.dynamic_mapping.epg-name	string	Optional	Endpoint Group Name.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object setting.
params.data.dynamic_mapping.fqdn	string	Optional	Fully qualified Domain Name.
params.data.dynamic_mapping.global-object	number	Optional	Global Object setting.
params.data.dynamic_mapping.host	string	Optional	Host IPv6 Address.
params.data.dynamic_mapping.host-type	string	Optional	Host Type.

Input Example

{"method":"string","params":[{"data":{"_image-base64":"string","cache-ttl":123,"color":123,"comment":"string","country":["string"],"dynamic_mapping":[{"_image-base64":"string","_scope":[],"cache-ttl":123,"color":123,"comment":"string","country":["string"],"end-ip":"string","end-mac":"string","epg-name":"Example Name","fabric-object":"string","fqdn":"string","global-object":123,"host":"string","host-type":"string","ip6":"string","macaddr":["string"],"obj-id":"string","route-tag":123,"sdn":["string"],"sdn-tag":"string","start-ip":"string","start-mac":"string","subnet-segment":[],"tags":["string"],"template":["string"],"tenant":"string","type":"ipprefix","uuid":"12345678-1234-1234-1234-123456789abc","visibility":"string"}],"end-ip":"string","epg-name":"Example Name","fabric-object":"string","fqdn":"string","host":"string","host-type":"string","ip6":"string","list":[{"ip":"string","net-id":"string","obj-id":"string"}],"macaddr":["string"],"name":"Example Name","obj-id":"string","route-tag":123,"sdn":["string"],"sdn-tag":"string","start-ip":"string","subnet-segment":[{"name":"Example Name","type":"string","value":"string"}],"tagging":[{"category":["string"],"name":"Example Name","tags":["string"]}],"template":["string"],"tenant":"string","type":"ipprefix","uuid":"12345678-1234-1234-1234-123456789abc"},"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Update Firewall IPv6 Address Group

Update an existing IPv6 address group in Fortinet FortiManager using specified 'adom' and 'addrgrp6'.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform Update.
params	array	Optional	Parameters for the update Method.
params.data	object	Optional	Data for the Address Group.
params.data._image-base64	string	Optional	Response data
params.data.color	number	Optional	Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets the value to 1).
params.data.comment	string	Optional	Comment for the Address Group.
params.data.dynamic_mapping	array	Optional	Dynamic Mapping Configurations.
params.data.dynamic_mapping._image-base64	string	Optional	Response data
params.data.dynamic_mapping._scope	array	Optional	Scope of the dynamic Mapping.
params.data.dynamic_mapping._scope.name	string	Optional	Name of the Scope.
params.data.dynamic_mapping._scope.vdom	string	Optional	VDOM of the Scope.
params.data.dynamic_mapping.color	number	Optional	Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets the value to 1).
params.data.dynamic_mapping.comment	string	Optional	Comment for the Mapping.
params.data.dynamic_mapping.exclude	string	Optional	Enable or disable Exclusion.
params.data.dynamic_mapping.exclude-member	array	Optional	Members to exclude.
params.data.dynamic_mapping.fabric-object	string	Optional	Security Fabric global Object.
params.data.dynamic_mapping.global-object	number	Optional	Global Object setting.
params.data.dynamic_mapping.member	array	Optional	Address Objects in Group.
params.data.dynamic_mapping.tags	array	Optional	Tags for the Group.
params.data.dynamic_mapping.uuid	string	Optional	Universally Unique Identifier.
params.data.dynamic_mapping.visibility	string	Optional	Visibility Setting.
params.data.exclude	string	Optional	Enable or disable Exclusion.
params.data.exclude-member	array	Optional	Members to exclude.
params.data.fabric-object	string	Optional	Security Fabric global Object.
params.data.member	array	Optional	Address Objects in Group.

Input Example

{"method":"string","params":[{"data":{"_image-base64":"string","color":123,"comment":"string","dynamic_mapping":[{"_image-base64":"string","_scope":[],"color":123,"comment":"string","exclude":"string","exclude-member":["string"],"fabric-object":"string","global-object":123,"member":["string"],"tags":["string"],"uuid":"12345678-1234-1234-1234-123456789abc","visibility":"string"}],"exclude":"string","exclude-member":["string"],"fabric-object":"string","member":["string"],"name":"Example Name","tagging":[{"category":["string"],"name":"Example Name","tags":["string"]}],"uuid":"12345678-1234-1234-1234-123456789abc"},"url":"https://example.com/api/resource"}],"session":"string","id":123}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Update Firewall Wildcard FQDN

Update a custom wildcard FQDN in Fortinet FortiManager, requiring an administrative domain and custom parameters.

Endpoint

URL: /jsonrpc

Method: POST

Input

Argument Name	Type	Required	Description
method	string	Optional	Method to perform Update.
params	array	Optional	List of Parameter Objects.
params.data	object	Optional	Data Object containing Update Details.
params.data.color	number	Optional	GUI Icon Color Identifier.
params.data.comment	string	Optional	Comment for the Address.
params.data.name	string	Optional	Name of the Address.
params.data.uuid	string	Optional	Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
params.data.wildcard-fqdn	string	Optional	Wildcard Fully Qualified Domain Name.
params.url	string	Optional	URL for the Request. URL should be in the format /pm/config/adom//obj/firewall/wildcard-fqdn/custom/. Replace and with the appropriate values.
session	string	Optional	Session Identifier.
id	number	Optional	Identifier for the Request.

Input Example

{"json_body":{"method":"update","params":[{"data":{"color":0,"comment":" ","name":" ","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","wildcard-fqdn":" "},"url":"/pm/config/adom/{adom}/obj/firewall/wildcard-fqdn/custom/{custom}"}],"session":" ","id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
method	string	HTTP method to use
result	array	Result of the operation
result.data	object	Response data
result.data.name	string	Response data
result.status	object	Status value
result.status.code	number	Status value
result.status.message	string	Status value
result.url	string	URL endpoint for the request
id	number	Unique identifier

Output Example

Response Headers

Header	Description	Example
connection	HTTP response header: connection	Keep-Alive
content-length	The length of the response body in bytes	140
content-type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 2 May 2024 20:37:23 GMT
keep-alive	HTTP response header: keep-alive	timeout=5,max=100
permissions-policy	HTTP response header: permissions-policy	geolocation=(self),microphone=()
referrer-policy	HTTP response header: referrer-policy	no-referrer-when-downgrade
server	Information about the software used by the origin server	Apache/2.4.41 (Ubuntu)
strict-transport-security	HTTP response header: strict-transport-security	max-age=31536000; includeSubDomains; preload
x-content-type-options	HTTP response header: x-content-type-options	nosniff
x-frame-options	HTTP response header: x-frame-options	SAMEORIGIN