Fortinet FortiManager

the fortinet fortimanager connector enables streamlined management and automation of security policies and objects within the fortimanager platform fortinet fortimanager is a centralized security management platform that simplifies the orchestration of security policies across your network infrastructure this connector enables swimlane turbine users to automate the management of firewall configurations, domain filters, and security policies directly within the swimlane platform by integrating with fortimanager, security teams can enhance their response capabilities, enforce consistent security postures, and reduce manual configuration errors 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, ensure you have the following api key authentication with the following parameters url the endpoint url for the fortimanager api api key token a valid api key token to authenticate requests to fortimanager 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 https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4143/5/pm/config/dnsfilter/ and choose the api /pm/config/adom/{adom}/obj/dnsfilter/domain filter (add) to find the parameters details url format /pm/config/adom/{adom}/obj/dnsfilter/domain filter block file hash use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4143/5/pm/config/ips/ and choose the api /pm/config/adom/{adom}/obj/ips/custom (add) to find the parameters details url format /pm/config/adom/{adom}/obj/ips/custom create firewall address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp (add) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp create firewall address and block ip use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address (add) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address create firewall ipv6 address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address6 (add) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address6 create firewall ipv6 address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp6 (add) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp6 create firewall wildcard fqdn use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom (add) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom delete firewall address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address/{address} (delete) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address/{address} delete firewall address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} (delete) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} delete firewall ipv6 address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address6/{address6} (delete) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address6/{address6} delete firewall ipv6 address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} (delete) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} delete firewall wildcard fqdn use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom (delete) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom/{custom} get domain filter use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4143/5/pm/config/dnsfilter/ and choose the api /pm/config/adom/{adom}/obj/dnsfilter/domain filter (get) to find the parameters details url format /pm/config/adom/{adom}/obj/dnsfilter/domain filter get firewall address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address/{address} (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address/{address} get firewall address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} get firewall entries use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4143/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address/{address} (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address/{address} get firewall ipv6 address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address6/{address6} (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address/{address} get firewall ipv6 address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} get firewall wildcard fqdn use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom (get) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom/{custom} update firewall address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address/{address} (update) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address/{address} update firewall address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} (update) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp/{addrgrp} update firewall ipv6 address use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/address6/{address6} (update) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/address6/{address6} update firewall ipv6 address group use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} (update) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/addrgrp6/{addrgrp6} update firewall wildcard fqdn use this https //fndn fortinet net/index php?/fortiapi/5 fortimanager/4554/5/pm/config/firewall/ and choose the api /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom (update) to find the parameters details url format /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom/{custom} 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 creates 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/{adom}/obj/dnsfilter/domain filter replace {adom} 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 blocks a specified file hash across the network utilizing fortinet fortimanager an 'adom' path parameter is required 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/{adom}/obj/ips/custom replace {adom} 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 {"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 create firewall address and block ip adds a new firewall address object and blocks 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/{adom}/obj/firewall/address replace {adom} 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 {"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 create firewall address group adds a new address group to the firewall configuration in fortinet fortimanager, requiring a '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 {"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 create firewall ipv6 address adds 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 with 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 adds a new wildcard fqdn to the specified adom in the fortinet fortimanager firewall configuration, requiring 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/{adom}/obj/firewall/wildcard fqdn/custom replace {adom} 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 {"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 delete firewall address removes a specified firewall address from fortinet fortimanager using the '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/{adom}/obj/firewall/address/{address} replace {adom} and {address} 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 {"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 delete firewall address group removes 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/{adom}/obj/firewall/addrgrp/{addrgrp} replace {adom} and {addrgrp} 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 {"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 delete firewall ipv6 address removes a specified ipv6 address object from a fortimanager adom, requiring '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/{adom}/obj/firewall/address6/{address6} replace the {adom} and {address6} 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 removes a specified ipv6 address group from the fortinet fortimanager firewall configuration 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/{adom}/obj/firewall/addrgrp6/{addrgrp6} replace {adom} and {addrgrp6} 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 {"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 wildcard fqdn removes a specified custom wildcard fqdn from the firewall configuration in fortinet fortimanager, 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 url parameters params url string optional url path for the request the url should be in the format /pm/config/adom/{adom}/obj/firewall/wildcard fqdn/custom/{custom} replace the {adom} and {custom} 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 {"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 get domain filter retrieve domain filter settings from fortinet fortimanager for a specified administrative domain 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/{adom}/obj/dnsfilter/domain filter replace {adom} 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 {"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 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/{adom}/obj/firewall/address/{address} replace {adom} and {address} 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 {"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 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/{adom}/obj/firewall/addrgrp/{addrgrp} replace {adom} and {addrgrp} 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 {"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 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/{adom}/obj/firewall/address/{address} replace {adom} and {address} 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 {"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 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/{adom}/obj/firewall/address/{address} replace {adom} and {address} 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/{adom}/obj/firewall/addrgrp6/{addrgrp6} replace {adom} and {addrgrp6} 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 the 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/{adom}/obj/firewall/wildcard fqdn/custom/{custom} replace {adom} and {custom} 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 {"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 update firewall address updates 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 {"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 update firewall address group updates 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 {"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 update firewall ipv6 address updates an existing ipv6 address object within a specified adom and address6 in the fortinet fortimanager firewall, with 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 {"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" "update","result" \[{}],"id" 1}} update firewall ipv6 address group updates 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 {"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" "update","result" \[{}],"id" 1}} update firewall wildcard fqdn updates 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/{adom}/obj/firewall/wildcard fqdn/custom/{custom} replace {adom} and {custom} 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 {"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 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