Customer policy installation details
Return a list of policy installations executed for the customer
Valid date formats are ’yyyy-MM-dd HH:mm’ or ’yyyy-MM-dd HH:mm:ss’; other formats result in an invalid date error response.
Method |
URL |
Description |
Arguments |
Outputs |
---|---|---|---|---|
GET |
/fpc/api/customers/{cid}/installs/?startdate=’yyyy-MM-dd HH:mm:ss’&enddate= ’yyyy-MM-dd HH:mm:ss' |
Return a list of policy installations executed for the customer |
cid, Startdate, Enddate |
See the Outputs table. |
Argument—Path
Parameter |
Type |
Description |
---|---|---|
cid (required) |
int |
Customer ID. |
Arguments—Query
Parameter |
Type |
Description |
---|---|---|
Startdate (required) |
string |
Startdate: start of date range. Date format : ‘yyyy-MM-dd HH:mm:ss’ |
Enddate (required) |
string |
Enddate: end of date range. Date format : ‘yyyy-MM-dd HH:mm:ss’ |
Outputs
HTTP Response: 200 OK
Response Data: Array of policy installations details
Parameter |
Type |
Description |
---|---|---|
Id |
int |
Installation ID |
taskId |
int |
Task ID for installation as in FortiManager |
customerId |
int |
Customer ID |
customerName |
string |
Customer name |
userId |
int |
User Id who initiated policy installation |
username |
string |
User name |
deviceName |
string |
Device name (FortiGate name) |
packageName |
string |
Name of package in FortiManager that is being installed in device |
vdomName |
string |
Vdom Name in FortiManager |
adomName |
string |
Adom Name in FortiManager |
taskDetails |
string |
Message about installation task |
fortiManagerId |
int |
FortiManager ID |
createdOn |
long |
Created on |
Get details of a specific policy installation
Installid is the Id of Installation resources
Method |
URL |
Description |
Arguments |
Outputs |
---|---|---|---|---|
GET |
/fpc/api/customers/{cid}/installs/{installid} |
Get details of policy installation for given install id |
See the next table. |
See the Output table. |
Arguments (Path parameter)
Parameter |
Type |
Description |
---|---|---|
InstallId (required) |
int |
Installation identifier |
customerId (required) |
int |
Customer identifier |
Output
HTTP Response 200 OK
Parameter |
Type |
Description |
---|---|---|
InstallId (required) |
int |
Installation ID |
taskId |
int |
Taskid for installation as in FortiManager |
customerId |
int |
Customer ID |
customerName |
string |
Customer name |
installationLog |
string |
Installation log details from FortiManager |
errorCoce |
string |
Error code from FortiManager |
errorMsg |
string |
Error message from FortiManager |