Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure API users.

  config system api-user
      Description: Configure API users.
      edit <name>
          set comments {var-string}
          set api-key {password-2}
          set accprofile {string}
          set vdom <name1>, <name2>, ...
          set schedule {string}
          set cors-allow-origin {string}
          set peer-auth [enable|disable]
          set peer-group {string}
          config trusthost
              Description: Trusthost.
              edit <id>
                  set type [ipv4-trusthost|ipv6-trusthost]
                  set ipv4-trusthost {ipv4-classnet}
                  set ipv6-trusthost {ipv6-prefix}
              next
          end
      next
  end

config system api-user

Parameter Name Description Type Size
comments Comment. var-string Maximum length: 255
api-key Admin user password. password-2 Not Specified
accprofile Admin user access profile. string Maximum length: 35
vdom <name> Virtual domains.
Virtual domain name.
string Maximum length: 79
schedule Schedule name. string Maximum length: 35
cors-allow-origin Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible. string Maximum length: 269
peer-auth Enable/disable peer authentication.
enable: Enable peer.
disable: Disable peer.
option -
peer-group Peer group name. string Maximum length: 35

config trusthost

Parameter Name Description Type Size
type Trusthost type.
ipv4-trusthost: IPv4 trusthost.
ipv6-trusthost: IPv6 trusthost.
option -
ipv4-trusthost IPv4 trusted host address. ipv4-classnet Not Specified
ipv6-trusthost IPv6 trusted host address. ipv6-prefix Not Specified

Configure API users.

  config system api-user
      Description: Configure API users.
      edit <name>
          set comments {var-string}
          set api-key {password-2}
          set accprofile {string}
          set vdom <name1>, <name2>, ...
          set schedule {string}
          set cors-allow-origin {string}
          set peer-auth [enable|disable]
          set peer-group {string}
          config trusthost
              Description: Trusthost.
              edit <id>
                  set type [ipv4-trusthost|ipv6-trusthost]
                  set ipv4-trusthost {ipv4-classnet}
                  set ipv6-trusthost {ipv6-prefix}
              next
          end
      next
  end

config system api-user

Parameter Name Description Type Size
comments Comment. var-string Maximum length: 255
api-key Admin user password. password-2 Not Specified
accprofile Admin user access profile. string Maximum length: 35
vdom <name> Virtual domains.
Virtual domain name.
string Maximum length: 79
schedule Schedule name. string Maximum length: 35
cors-allow-origin Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible. string Maximum length: 269
peer-auth Enable/disable peer authentication.
enable: Enable peer.
disable: Disable peer.
option -
peer-group Peer group name. string Maximum length: 35

config trusthost

Parameter Name Description Type Size
type Trusthost type.
ipv4-trusthost: IPv4 trusthost.
ipv6-trusthost: IPv6 trusthost.
option -
ipv4-trusthost IPv4 trusted host address. ipv4-classnet Not Specified
ipv6-trusthost IPv6 trusted host address. ipv6-prefix Not Specified