Fortinet Document Library

Version:


Table of Contents

6.2.3
Download PDF
Copy Link

API Proxy

FortiWeb device has provided a series of native APIs for the user to manage its own internal items, e.g. https://172.22.10.74:90/api/v1.0/System/Network/StaticRoute. FortiWeb Manager encapsulates all necessary information of native FortiWeb APIs and uses two easier-to-use APIs for configuration management:

  • to-fwb API: https://<fortiweb_manager_address>:<port>/api/v1/to-fwb/, used for all remote configuration requests, including fetching, creating, updating and deleting. You can specify parameters such as device, method and URL to let FortiWeb Manager know more details of the configuration requests.
  • to-fwb/upload API: https://<fortiweb_manager_address>:<port>/api/v1/to-fwb/upload/, used to upload files, for instance, certificate uploading. FortiWeb Manager supports three pre-set file types: Certificate, Local Certificate, PKCS12 Certificate. You can also select File - Custom to upload customized files.

The following diagram shows the process of FortiWeb Manager receiving these API requests, translating them to native FortiWeb APIs and forwarding the corresponding ones to the remote FortiWeb devices.



note icon

Using API proxy is an easier way to integrate multiple FortiWeb devices into your own management system.

Using API proxy

The API proxy page is a useful tool to look up the HTTP request and HTTP response of the to-fwb API and to-fwb/upload API. You can configure the following parameters and click Send, the page then displays the HTTP request and HTTP response for the parameters you have specified.

Device

Select the devices to which the API request sends.

Type
  • JSON - Custom: customize the HTTP request parameters as JSON format payload when connecting to FortiWeb devices.
  • File - Custom: specify local files for uploading to FortiWeb devices.
  • File - Certificate: upload certificate to FortiWeb devices.
  • File - Local Certificate: upload local certificate to FortiWeb devices.
  • File - PKCS12 Certificate: upload PKCS12 certificate to FortiWeb devices.
Method

Select GET, POST, PUT or DELETE methods, depending on the operations you desire.

URL

Enter the FortiWeb API URL for the specific operations.

Parameter List

This displays when you select File types in Type. You can select the files you want to upload.

tooltip icon

For more information on the FortiWeb Manager API and FortiWeb API usage, see:

 

 

API Proxy

FortiWeb device has provided a series of native APIs for the user to manage its own internal items, e.g. https://172.22.10.74:90/api/v1.0/System/Network/StaticRoute. FortiWeb Manager encapsulates all necessary information of native FortiWeb APIs and uses two easier-to-use APIs for configuration management:

  • to-fwb API: https://<fortiweb_manager_address>:<port>/api/v1/to-fwb/, used for all remote configuration requests, including fetching, creating, updating and deleting. You can specify parameters such as device, method and URL to let FortiWeb Manager know more details of the configuration requests.
  • to-fwb/upload API: https://<fortiweb_manager_address>:<port>/api/v1/to-fwb/upload/, used to upload files, for instance, certificate uploading. FortiWeb Manager supports three pre-set file types: Certificate, Local Certificate, PKCS12 Certificate. You can also select File - Custom to upload customized files.

The following diagram shows the process of FortiWeb Manager receiving these API requests, translating them to native FortiWeb APIs and forwarding the corresponding ones to the remote FortiWeb devices.



note icon

Using API proxy is an easier way to integrate multiple FortiWeb devices into your own management system.

Using API proxy

The API proxy page is a useful tool to look up the HTTP request and HTTP response of the to-fwb API and to-fwb/upload API. You can configure the following parameters and click Send, the page then displays the HTTP request and HTTP response for the parameters you have specified.

Device

Select the devices to which the API request sends.

Type
  • JSON - Custom: customize the HTTP request parameters as JSON format payload when connecting to FortiWeb devices.
  • File - Custom: specify local files for uploading to FortiWeb devices.
  • File - Certificate: upload certificate to FortiWeb devices.
  • File - Local Certificate: upload local certificate to FortiWeb devices.
  • File - PKCS12 Certificate: upload PKCS12 certificate to FortiWeb devices.
Method

Select GET, POST, PUT or DELETE methods, depending on the operations you desire.

URL

Enter the FortiWeb API URL for the specific operations.

Parameter List

This displays when you select File types in Type. You can select the files you want to upload.

tooltip icon

For more information on the FortiWeb Manager API and FortiWeb API usage, see: