Fortinet black logo

Admin Guide

API

API

FortiExtender Cloud has public APIs that allow you to access event logs, device information, and apply configurations to your devices. To access the APIs, you must present either a FortiExtender Cloud token or a FAC OAuth token.

API Schema and documentation

To see the FortiExtender Cloud API schema, you will need a Fortinet Developer Network account.

Once you have an account, you can access the FortiExtender Cloud API documentation.

API Tokens

FortiExtender Cloud tokens can be generated by users who can access the FortiExtender Cloud portal. The permission roles (Admin, ReadWrite, ReadOnly) granted by a FortiExtender Cloud token matches the role of the user who generated it.

FAC OAuth tokens can be generated when you create an API User in the Identity and Access Management (IAM) portal. You can modify the permissions from the IAM portal. Users who use OAuth tokens can only access services by calling APIs, they cannot log into FortiExtender Cloud.

Caution

Keep your API token confidential.

To generate a FortiExtender Cloud API token:
  1. From the navigation bar, click Account > API Token.

    A window loads with your specific API token.

You can invalidate the previous token and generate a new API token by clicking Reset .

To generate a FAC OAuth token:

For instructions on how to generate a FAC OAuth token, refer to "API users" in the Identity and Access Management Administration Guide.

Note

FortiExtender Cloud tokens do not expire while FAC OAuth tokens do. The expiration time for FAC OAuth tokens are returned in the response when you init or refresh a FAC OAuth token. You should init a new FAC OAuth token or refresh the token before it expires to ensure that you can access the APIs.

API

FortiExtender Cloud has public APIs that allow you to access event logs, device information, and apply configurations to your devices. To access the APIs, you must present either a FortiExtender Cloud token or a FAC OAuth token.

API Schema and documentation

To see the FortiExtender Cloud API schema, you will need a Fortinet Developer Network account.

Once you have an account, you can access the FortiExtender Cloud API documentation.

API Tokens

FortiExtender Cloud tokens can be generated by users who can access the FortiExtender Cloud portal. The permission roles (Admin, ReadWrite, ReadOnly) granted by a FortiExtender Cloud token matches the role of the user who generated it.

FAC OAuth tokens can be generated when you create an API User in the Identity and Access Management (IAM) portal. You can modify the permissions from the IAM portal. Users who use OAuth tokens can only access services by calling APIs, they cannot log into FortiExtender Cloud.

Caution

Keep your API token confidential.

To generate a FortiExtender Cloud API token:
  1. From the navigation bar, click Account > API Token.

    A window loads with your specific API token.

You can invalidate the previous token and generate a new API token by clicking Reset .

To generate a FAC OAuth token:

For instructions on how to generate a FAC OAuth token, refer to "API users" in the Identity and Access Management Administration Guide.

Note

FortiExtender Cloud tokens do not expire while FAC OAuth tokens do. The expiration time for FAC OAuth tokens are returned in the response when you init or refresh a FAC OAuth token. You should init a new FAC OAuth token or refresh the token before it expires to ensure that you can access the APIs.