Fortinet Document Library

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

Accessing the REST API

The FortiAuthenticator API can be accessed from most browsers (GET) however browser add-ons may be required for extended operations (e.g. PUT). More complicated, scripted queries can be made using utilities such as cURL and most scripting languages such as Perl or Python have built in libraries for interacting with RESTful APIs.

Example shown within this document will be demonstrated with the cross platform utility cURL.

All of the resource URLs are in this form:

https://[server_name]/api/[api_version]/[resource]/

where:

server_name = Name or IP of the FortiAuthenticator
api_version = API version to be used (currently v1)
resource = Resource or part of config to be viewed
id = Resource ID to view, edit, or delete

Accessing the REST API

The FortiAuthenticator API can be accessed from most browsers (GET) however browser add-ons may be required for extended operations (e.g. PUT). More complicated, scripted queries can be made using utilities such as cURL and most scripting languages such as Perl or Python have built in libraries for interacting with RESTful APIs.

Example shown within this document will be demonstrated with the cross platform utility cURL.

All of the resource URLs are in this form:

https://[server_name]/api/[api_version]/[resource]/

where:

server_name = Name or IP of the FortiAuthenticator
api_version = API version to be used (currently v1)
resource = Resource or part of config to be viewed
id = Resource ID to view, edit, or delete