API reference

This section shows how to use APIs to integrate the FortiManager Integration App with other ServiceNow apps.

API calls to the app use the ServiceNow API credentials configured in FortiManager System Properties. No further authentication is done.

API calls are allowed from anywhere in the ServiceNow platform. Consider limiting access to ServiceNow scripts to users with authorization to create FortiManager change requests.

There are three APIs for inbound integration:

• CreateScript - Creates and executes scripts and configuration installations.

• CheckExec - Checks script execution status on FortiManager.

• CheckDeploy - Checks configuration installation status on FortiManager.

Using CreateScript

Request object:

Request parameters:

Name	Description
method	Should be “POST”
params	url	Should be “CreateScript”
	script	Name of script template in FortiManager GUI.
	scriptVars	Optional: If a script template includes variables, specify the value of variables.
	adom	The ADOM which the script template belongs to.
	devices	Optional: If the type of script is device_database or remote_device, specify the name of devices.
	description	Description of this new change.
	Policy	Optional: If the type of script is adom_database, specify the name of policies.

Sample CreateScript request:

Sample CreateScript response:

Using CheckExec

Request object:

Request parameters:

Name	Description
method	Should be “POST”
params	url	Should be “CheckExec”
	number	The unique tracking string for ServiceNow table. It can be retrieved from the display_value variable from “Create Script” response.

Sample CheckExec request:

Sample CheckExec response:

Using CheckDeploy

Request object:

Request parameters:

Name	Description
method	Should be “POST”
params	url	Should be “CheckDeploy”
	number	The unique tracking string for ServiceNow table. It can be retrieved from the display_value variable from “Create Script” response.

Sample CheckDeploy request:

Sample CheckDeploy response: