Fortinet black logo

Enabling the REST API access mode

Enabling the REST API access mode

When making requests to FortiVoice appliances using the REST API, you need:

  • A valid admin username and password (so that an authenticated session can be established).
  • Appropriate access permissions for the requested resource (controlled by admin profile).
  • For an administrator to use the REST API, it has to be enabled as the access mode for the administrator.

To enable the access mode on the FortiVoice phone system using the CLI

    config system admin

    edit admin

    set access cli gui rest

    end

To enable the access mode on the FortiVoice phone system using the GUI
  1. Go to System > Administrator > Administrator.
  2. Click New.
  3. For Access mode, enable REST API.
  4. Click OK.

Enabling the REST API access mode

When making requests to FortiVoice appliances using the REST API, you need:

  • A valid admin username and password (so that an authenticated session can be established).
  • Appropriate access permissions for the requested resource (controlled by admin profile).
  • For an administrator to use the REST API, it has to be enabled as the access mode for the administrator.

To enable the access mode on the FortiVoice phone system using the CLI

    config system admin

    edit admin

    set access cli gui rest

    end

To enable the access mode on the FortiVoice phone system using the GUI
  1. Go to System > Administrator > Administrator.
  2. Click New.
  3. For Access mode, enable REST API.
  4. Click OK.