Technical Tip: How to run a proxy API call from FortiManager to a managed FortiGate

[tnesh]

Description

This article describes how to run a proxy API call from FortiManager to a managed FortiGate to collect data.

Scope

FortiManager and FortiGate.

Solution

1. FortiManager will send proxy API calls via url:"sys/proxy/json" to managed FortiGate API "resource": "<FortiGate API Call>" via the FGFM tunnel that established between the FortiManager and the managed FortiGate.
   

Note:

For a complete list of FortiGate API calls, refer to Fortinet Development Network (FNDN):

{
     "id" : "1",
     "method": "exec",
     "params": [
         {
             "url": "sys/proxy/json",
             "data": {
                   "target": [ "device/<device-name>" ],
                   "action": "get",
                   "resource": "<FortiGate API Call>"
             }
         }
     ],
     "session" : "<session-id>"
}

2. Below are two sample usages of proxy calls from FortiManager to a managed FortiGate:

• Get FortiGate Firewall Address:

{
     "id" : "1",
     "method": "exec",
     "params": [
         {
             "url": "sys/proxy/json",
             "data": {
                   "target": [ "device/lab-fgt2" ],
                   "action": "get",
                   "resource": "/api/v2/cmdb/firewall/address"
             }
         }
     ],
     "session" : "{{session-id}}"
}

• Get FortiGate License Info:

{
     "id" : "1",
     "method": "exec",
     "params": [
         {
             "url": "sys/proxy/json",
             "data": {
                   "target": [ "device/lab-fgt2" ],
                   "action": "get",
                   "resource": "/api/v2/monitor/license/status"
             }
         }
     ],
     "session" : "{{session-id}}"
}

Related articles:

• Technical Tip: Using FortiManager API.
• Fortinet Development Network (FNDN) - FortiManager.
• Fortinet Development Network (FNDN) - FortiGate.
• Technical Tip: Managing the JSON API call with Postman and how to delete, create and update an ADOM ...
• API admin setup.
• Technical Tip: Using Firmware Manager CLI and API.
• Technical Tip: Managing the JSON API call with cURL under Linux/Gnu and how to get, delete and creat....
• Technical Tip: How to run a proxy API call from FortiManager to a managed FortiGate.
• Technical Tip: API requests by using the API token authentication method with Postman.
• Technical Tip: Invalid protocol number when retrieving Service Object from FortiGate registered with....
• Technical Tip: Application of Terraform on FortiManager.
• FortiManager JSON API Introduction