Fortinet black logo

Handbook

Importing OpenAPI schema

Importing OpenAPI schema

An OpenAPI schema file defines or describes the API including information like the API URL, parameter names in the URL, type of data parameters should have (string, integer, etc), where parameters are submitted (URL, header, body, etc.), and so on. For more information about OpenAPI files, see https://github.com/OAI/OpenAPI-Specification.

Once you upload the valid OpenAPI schema file, FortiADC will parse the file and then block requests that do not match the definitions in the file.

Before you begin, you must:

l Prepare a trusted OpenAPI schema file in YAML or JSON format that you can import to FortiADC. Acceptable file

types are .tar, .tar.gz, and .zip.

To import an OpenAPI schema file:
  1. Go to Web Application Firewall > OpenAPI Validation.
  2. Click the OpenAPI Schema tab.
  3. Click Create New.
  4. Enter the name of the OpenAPI schema configuration. You will use the name to select the schema file in OpenAPI Detection profiles.
  5. Click Choose File and select the OpenAPI schema file that you want to import.
  6. Click Save.

Importing OpenAPI schema

An OpenAPI schema file defines or describes the API including information like the API URL, parameter names in the URL, type of data parameters should have (string, integer, etc), where parameters are submitted (URL, header, body, etc.), and so on. For more information about OpenAPI files, see https://github.com/OAI/OpenAPI-Specification.

Once you upload the valid OpenAPI schema file, FortiADC will parse the file and then block requests that do not match the definitions in the file.

Before you begin, you must:

l Prepare a trusted OpenAPI schema file in YAML or JSON format that you can import to FortiADC. Acceptable file

types are .tar, .tar.gz, and .zip.

To import an OpenAPI schema file:
  1. Go to Web Application Firewall > OpenAPI Validation.
  2. Click the OpenAPI Schema tab.
  3. Click Create New.
  4. Enter the name of the OpenAPI schema configuration. You will use the name to select the schema file in OpenAPI Detection profiles.
  5. Click Choose File and select the OpenAPI schema file that you want to import.
  6. Click Save.