Fortinet black logo

Administration Guide

JSON API

Copy Link
Copy Doc ID 666526c9-6f4b-11ed-8e6d-fa163e15d75b:648559
Download PDF

JSON API

FortiDeceptor provides a Representational State Transfer (REST) API for interaction with system components. Programs communicate with the REST API over HTTP, the same protocol your web browser uses to interact with web pages.

The REST-API authentication is based on a token generated by the FortiDeceptor.

The FortiDeceptor API has the following capabilities:

  • Get the decoy deployment template list.

  • Deploy decoys based on the decoy template configuration and the deployment network configuration (both STATIC and DHCP IP).

  • Get a decoy deployment status.

  • Stop/start the deployed decoys.

  • Get incident alerts based on filter requests like time range (last minutes/hours/days) / service name/decoy name.

The FortiDeceptor JSON API Reference guide is available in the Fortinet Developer Network (FNDN). To access the guide, log in to FNDN and enter FortiDeceptor in the Search field.

Fortinet Developer Network is a subscription-based community. For more information about FNDN, visit Fortinet Worldwide Developer Community.

JSON API

FortiDeceptor provides a Representational State Transfer (REST) API for interaction with system components. Programs communicate with the REST API over HTTP, the same protocol your web browser uses to interact with web pages.

The REST-API authentication is based on a token generated by the FortiDeceptor.

The FortiDeceptor API has the following capabilities:

  • Get the decoy deployment template list.

  • Deploy decoys based on the decoy template configuration and the deployment network configuration (both STATIC and DHCP IP).

  • Get a decoy deployment status.

  • Stop/start the deployed decoys.

  • Get incident alerts based on filter requests like time range (last minutes/hours/days) / service name/decoy name.

The FortiDeceptor JSON API Reference guide is available in the Fortinet Developer Network (FNDN). To access the guide, log in to FNDN and enter FortiDeceptor in the Search field.

Fortinet Developer Network is a subscription-based community. For more information about FNDN, visit Fortinet Worldwide Developer Community.