FortiAnalyzer reports for a customer
Assign FortiAnalyzer reports to a customer
|
Method |
URL |
Description |
Arguments |
Outputs |
|---|---|---|---|---|
|
POST |
/customers/{cid}/assignfazreports |
Assign one or more available FortiAnalyzer reports to a specific customer |
See the following tables. |
HTTP Response 200 OK |
Arguments
|
Parameter |
Type |
Description |
|---|---|---|
|
cid |
int |
Required. Customer ID |
Arguments (JSON payload)
|
Parameter |
Type |
Description |
|---|---|---|
|
Reportids |
List (integer) |
Required. Identifiers for one or more FortiAnalyzer reports to be assigned to the customer |
Outputs
HTTP Response 200 OK
Unassign FortiAnalyzer reports from a customer
|
Method |
URL |
Description |
Arguments |
Outputs |
|---|---|---|---|---|
|
POST |
/customers/{cid}/unassignfazreports |
Unassign one or more available FortiAnalyzer reports from a specific customer |
See the following tables. |
HTTP Response 200 OK |
Arguments
|
Parameter |
Type |
Description |
|---|---|---|
|
cid |
int |
Required. Customer ID |
Arguments (JSON payload)
|
Parameter |
Type |
Description |
|---|---|---|
|
Reportids |
List (integer) |
Required. Identifiers for one or more FortiAnalyzer reports to be unassigned from the customer |
Outputs
HTTP Response 200 OK
Get unassigned FortiAnalyzer reports that the specified customer can assign
|
Method |
URL |
Description |
Arguments |
Outputs |
|---|---|---|---|---|
|
GET |
/customers/{cid}/availablefazreports |
Retrieve a list of unassigned FortiAnalyzer reports that the specified customer can assign |
cid |
See the Outputs table. |
Arguments
|
Parameter |
Type |
Description |
|---|---|---|
|
cid |
int |
Required. Customer ID |
Outputs (FortiAnalyzer report record)
The FortiAnalyzer report record contains the following fields:
|
Parameter |
Type |
Description |
|---|---|---|
|
ipAddress |
string |
IP address of the FortiAnalyzer |
|
reportName |
string |
Name of the FortiAnalyzer report |
|
startTime |
string |
The start time of the period covered by the report |
|
endTime |
string |
The end time of the period covered by the report |
|
fazName |
string |
Name of the FortiAnalyzer |
|
adom |
string |
Name of ADOM |
|
reportId |
int |
Report identifier |
|
customerId |
int |
Customer identifier |
|
fazId |
int |
FortiAnalyzer identifier |
|
customerName |
string |
Customer name |
|
devices |
int |
Number of FortiAnalyzer units |
Get FortiAnalyzer reports that are assigned to the specified customer
|
Method |
URL |
Description |
Arguments |
Outputs |
|---|---|---|---|---|
|
GET |
/customers/{cid}/assignedfazreports |
Retrieve a list of FortiAnalyzer reports that are assigned to the specified customer |
cid |
See the Outputs table. |
Arguments
|
Parameter |
Type |
Description |
|---|---|---|
|
cid |
int |
Required. Customer ID |
Outputs (FortiAnalyzer report record)
The FortiAnalyzer report record contains the following fields:
|
Parameter |
Type |
Description |
|---|---|---|
|
ipAddress |
string |
IP address of the FortiAnalyzer |
|
reportName |
string |
Name of the FortiAnalyzer report |
|
startTime |
string |
The start time of the period covered by the report |
|
endTime |
string |
The end time of the period covered by the report |
|
fazName |
string |
Name of the FortiAnalyzer |
|
adom |
string |
Name of ADOM |
|
reportId |
int |
Report identifier |
|
customerId |
int |
Customer identifier |
|
fazId |
int |
FortiAnalyzer identifier |
|
customerName |
string |
Customer name |
|
devices |
int |
Number of FortiAnalyzer units |