FortiAnalyzer

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

Get all FortiAnalyzer units

Method	URL	Description	Arguments	Outputs
GET	/fortianalyzers	Retrieve information about all FortiAnalyzer units	None	JSON array

Arguments

None

Outputs (FortiAnalyzer record)

HTTP Response 200 OK

Each FortiAnalyzer record contains the following fields:

Parameter	Type	Description
adminUserName	string	FortiAnalyzer user name
fazVersion	string	FortiAnalyzer firmware version
name	string	FortiAnalyzer name
ipAddress	string	IP address of the FortiAnalyzer
id	int	FortiAnalyzer identifier
status	string	Status of the FortiAnalyzer

Get detailed information for a specific FortiAnalyzer

Method	URL	Description	Arguments	Outputs
GET	/fortianalyzers/{faid}	Retrieve information for the specified FortiAnalyzer	faid	JSON array

Arguments

Parameter	Type	Description
faid	int	Required. FortiAnalyzer identifier

Outputs (FortiAnalyzer record)

HTTP Response 200 OK

The FortiAnalyzer record contains the following fields:

Parameter	Type	Description
id	int	FortiAnalyzer identifier
name	string	FortiAnalyzer name
ipAddress	string	IP address of the FortiAnalyzer
adminUserName	string	FortiAnalyzer user name
status	string	Status of the FortiAnalyzer
lastRunTime	int	Most recent FortiAnalyzer polling time
xmlPort	int	XML port number of the FortiAnalyzer
jsonPort	int	JSON port number of the FortiAnalyzer
fazVersion	string	FortiAnalyzer firmware version

Add a new FortiAnalyzer to FortiPortal

Method	URL	Description	Arguments	Outputs
POST	/fortianalyzers	Create a new FortiAnalyzer record	See the next table.	faid

Arguments (JSON payload)

Parameter	Type	Required	Description
name	String	Yes	FortiAnalyzer name
ipAddress	String	Yes	IP address of the FortiAnalyzer
adminUserName	String	Yes	FortiAnalyzer user name
adminPassword	String	Yes	FortiAnalyzer password
jsonPort	Integer	Yes	FortiAnalyzer JSON port
frequencyValue	String	No	FortiAnalyzer polling frequency; always set to poll daily
xmlPort	Integer	No	FortiAnalyzer XML port. The default value is 8080.

Outputs

Parameter	Type	Description
faid	int	FortiAnalyzer identifier

Edit the information for an existing FortiAnalyzer

Method	URL	Description	Arguments	Outputs
POST	/fortianalyzers/{faid}	Edit a FortiAnalyzer record	FortiAnalyzer identifier	HTTP Response 200 OK

Arguments

Parameter	Type	Description
faid	int	Required. FortiAnalyzer identifier
	JSON payload	See the next table.

Arguments (JSON payload)

Parameter	Type	Required	Description
name	String	Yes	FortiAnalyzer name
ipAddress	String	Yes	IP address of the FortiAnalyzer
adminUserName	String	Yes	FortiAnalyzer user name
adminPassword	String	Yes	FortiAnalyzer password
jsonPort	Integer	Yes	FortiAnalyzer JSON port
frequencyValue	String	No	FortiAnalyzer polling frequency; always set to poll daily
xmlPort	Integer	No	FortiAnalyzer XML port. The default value is 8080.

Outputs

HTTP Response 200 OK

Delete a FortiAnalyzer record

Method	URL	Description	Arguments	Outputs
DELETE	/fortianalyzers/{faid}	Delete the FortiAnalyzer record.	faid	HTTP Response 200 OK

Arguments

Parameter	Type	Description
faid	int	Required. FortiAnalyzer identifier

Outputs

HTTP Response 200 OK

Update the list of FortiAnalyzer reports

Method	URL	Description	Arguments	Outputs
GET	/fortianalyzers/{faid}/pollnow	Update the list of FortiAnalyzer reports.	faid	HTTP Response 200 OK

Arguments

Parameter	Type	Description
faid	int	Required. FortiAnalyzer identifier

Get FortiAnalyzer report templates for a specific FortiAnalyzer

Method	URL	Description	Arguments	Outputs
GET	/fortianalyzers/{faid}/reporttemplates	Retrieve a list of FortiAnalyzer report templates for a specific FortiAnalyzer	faid	JSON array

Arguments

Parameter	Type	Description
faid	int	Required. FortiAnalyzer identifier

Outputs (FortiAnalyzer report template record)

HTTP Response 200 OK

The FortiAnalyzer report template record contains the following fields:

Parameter	Type	Description
fazId	int	FortiAnalyzer identifier
reportName	string	Name of the FortiAnalyzer report template
reportId	int	FortiAnalyzer report template identifier
fazName	string	FortiAnalyzer name
customerId	int	Customer identifier
adom	string	Name of ADOM
customerName	string	Customer name