FortiManager

FortiPortal contains a record for each FortiManager that is registered in this FortiPortal.

Get FortiManager information

Method	URL	Description	Arguments	Outputs
GET	/fortimanagers	Retrieve FortiManager information	None	JSON array

Arguments

None

Outputs

Parameter	Type	Description
	JSON array	Array of FortiManager records, one entry per FortiManager. Each record contains a unique FortiManager ID. See the FortiManager Record table.

Get information for a specified FortiManager

Method	URL	Description	Arguments	Outputs
GET	/fortimanagers/{fmid}	Retrieve information for the specified FortiManager	fmid	See the Outputs table.

Arguments

Parameter	Type	Description
fmid	int	FortiManager identifier

Outputs (FortiManager record)

Parameter	Type	Description
fortiManagerId	int	FortiManager identifier
fortiManagerName	String	FortiManager name
haMode	String	HA mode (standalone, primary, or secondary)
Status	String	Status of the FortiManager
connectionStatus	String	Connection status - Up or Down.
ipAddress	String	IP address of the FortiManager
portNumber	int	Port number of the FortiManager

FortiManager polling

Method	URL	Description	Arguments	Outputs
GET	/fortimanagers/{fmid}/pollnow	The poll updates the list of FortiManager devices in the FortiPortal.	fmid	200 OK 400 Bad Request

Arguments

Parameter	Type	Description
fmid	int	FortiManager identifier

Create a FortiManager record

Method	URL	Description	Arguments	Outputs
POST	/fortimanagers	Create a new FortiManager record	userType	fmid

Arguments (FortiManager fields—JSON payload)

Parameter	Type	Required	Description
fortiManagerName	String	Yes	FortiManager name
ipAddress	String	Yes	IP address of the FortiManager
adminUserName	String	Yes	Admin user name
adminPassword	String	Yes	Password for the admin user.
frequencyValue	String	Yes	Polling frequency (No polling, daily, weekly or monthly).
portNumber	int	Yes	Port number of the FortiManager

Outputs

Parameter	Type	Description
fmid	int	FortiManager identifier

Edit a FortiManager record

Method	URL	Description	Arguments	Outputs
POST	/fortimanagers/{fmid}	Edit a FortiManager record	FortiManager identifier

Arguments

Parameter	Type	Description
fmid	int	FortiManager identifier
	JSON payload	See the FortiManager fields table.

Outputs

None.

Delete a FortiManager record

Method	URL	Description	Arguments	Outputs
POST	/fortimanagers/delete/{fmid}	Delete the FortiManager record.	fmid	none

Arguments

Parameter	Type	Description
fmid	int	FortiManager ID.

Outputs

None.