Fortinet Document Library

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

Supported API methods

All of the resource URLs are in this form: https://[server_name]/api/[api_version]/[resource]/. The current API version is v1.

To list all of the available resource endpoints, send a request to:

https://[server_name]/api/v1/?format=xml

To view schema, supported methods and available fields for each endpoint, append /schema/ to the endpoint URL. For example, to view schema for /auth/ API, perform a GET request to:

https://[server_name]/api/v1/auth/schema/?format=xml

In general, an endpoint may support the following methods, though not all methods are supported by all endpoints (see each endpoint's documentation for the list of allowed methods):

Method URL Operation description Success response code
GET
(list)
/[resource]/ Retrieve a list of all resources for the endpoint 200 OK
GET
(detail)
/[resource]/[id]/ Retrieve a specific resource with ID id from the endpoint 200 OK
POST /[resource]/ Create a new resource on the given endpoint. The data being POST-ed must follow the same format as the data returned by the GET parameter 201 CREATED
PUT
(list)
/[resource]/ Update all of the resources for the given endpoint. Any existing items will be replaced with the new data. Data must follow the same format as the data returned by the GET parameter. 204 NO CONTENT
PUT
(detail)
/[resource]/[id]/ Update an existing item specified with ID id. Data must follow the same format as the data returned by the GET parameter. 204 NO CONTENT
PATCH (detail)  /[resource]/[id]/ Update specific fields on an existing item with ID id 202 ACCEPTED
DELETE
(list)
/[resource]/ Delete all resources from an endpoint 204 NO CONTENT
DELETE(detail) /[resource]/[id]/ Delete an existing resource specified with ID id from an endpoint 204 NO CONTENT

Supported API methods

All of the resource URLs are in this form: https://[server_name]/api/[api_version]/[resource]/. The current API version is v1.

To list all of the available resource endpoints, send a request to:

https://[server_name]/api/v1/?format=xml

To view schema, supported methods and available fields for each endpoint, append /schema/ to the endpoint URL. For example, to view schema for /auth/ API, perform a GET request to:

https://[server_name]/api/v1/auth/schema/?format=xml

In general, an endpoint may support the following methods, though not all methods are supported by all endpoints (see each endpoint's documentation for the list of allowed methods):

Method URL Operation description Success response code
GET
(list)
/[resource]/ Retrieve a list of all resources for the endpoint 200 OK
GET
(detail)
/[resource]/[id]/ Retrieve a specific resource with ID id from the endpoint 200 OK
POST /[resource]/ Create a new resource on the given endpoint. The data being POST-ed must follow the same format as the data returned by the GET parameter 201 CREATED
PUT
(list)
/[resource]/ Update all of the resources for the given endpoint. Any existing items will be replaced with the new data. Data must follow the same format as the data returned by the GET parameter. 204 NO CONTENT
PUT
(detail)
/[resource]/[id]/ Update an existing item specified with ID id. Data must follow the same format as the data returned by the GET parameter. 204 NO CONTENT
PATCH (detail)  /[resource]/[id]/ Update specific fields on an existing item with ID id 202 ACCEPTED
DELETE
(list)
/[resource]/ Delete all resources from an endpoint 204 NO CONTENT
DELETE(detail) /[resource]/[id]/ Delete an existing resource specified with ID id from an endpoint 204 NO CONTENT