FortiOS JSON API Reference

FortiOS REST API

VERSION 5.2.3

FORTINET DOCUMENT LIBRARY FORTINET VIDEO GUIDE FORTINET BLOG CUSTOMER SERVICE & SUPPORT FORTIGATE COOKBOOK FORTINET TRAINING SERVICES FORTIGUARD CENTER END USER LICENSE AGREEMENT FEEDBACK Email: techdocs@

March 24, 2015 FortiOS 5.2.3 REST API 05-523-270937-201500324

TABLE OF CONTENTS

Change Log

8

Introduction

9

Authentication

9

CSRF Tokens

9

Setting Up an Authenticated Session

10

Supported HTTP methods

10

FortiOS REST API HTTP Response Codes

11

CMDB API

12

URL format

12

Parameters

13

List of Methods

14

collection

15

GET

15

Extra parameters

15

GET: default

16

GET: schema

16

DELETE

16

POST

16

resource

16

GET

17

Extra Parameters

17

PUT

17

PUT: move

17

Extra Parameters

18

POST: clone

18

Extra Parameters

18

DELETE

18

Monitor API

19

URL format

19

Parameters

19

List of Methods

19

firewall

26

health: select

26

local-in: select

26

policy: select

26

policy: reset

27

policy: clear_counters

27

Extra parameters

27

policy6: select

27

policy6: reset

28

policy6: clear_counters

28

Extra parameters

28

session: select

29

Extra parameters

29

session-top: clear_all

29

session-top: close

30

session-top: select

30

Extra parameters

30

shaper: select

31

shaper: reset

31

load-balance: select

31

Extra parameters

32

fortiview

33

statistics: select

33

Extra parameters

33

log

34

status: select

34

Extra parameters

34

status: reset

34

router

35

ipv4: select

35

Extra parameters

35

ipv6: select

35

Extra parameters

36

statistics: select

36

Extra parameters

36

system

38

dashboard: reboot

38

dashboard: shutdown

38

resource: select

38

dhcp: select

39

Extra parameters

39

dhcp: revoke

39

Extra parameters

39

firmware: select

40

firmware: upgrade

40

modem: select

40

modem: reset

40

modem: connect

41

modem: disconnect

41

3g-modem: select

41

sniffer: select

42

sniffer: restart

42

Extra parameters

42

sniffer: start

43

Extra parameters

43

sniffer: stop

43

Extra parameters

43

fsw:select

44

Extra parameters

44

fsw:update

44

interface:select

44

Extra parameters

45

fsw: update

45

interface:select

45

Extra parameters

45

debug:select

46

Extra parameters

46

extender: controller

47

extender: select

47

Extra parameters

47

extender: reset

47

user

48

firewall: select

48

firewall: deauth

48

banned: select

48

banned: clear_users

49

Extra parameters

49

banned: clear_all

49

fortitoken: activate

49

Extra parameters

50

fortitoken: refresh

50

Extra parameters

50

fortitoken: provision

51

Extra parameters

51

utm

52

av: select

52

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download