Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

MAC devices (/macdevices/)

URL: https://[server_name]/api/v1/macdevices/

This endpoint represents the MAC device resource.

Supported fields

Field Display name Type Required Other restrictions
name MAC device name String Yes Max length = 50.
address MAC address String Yes Max length = 25. Must be a valid MAC address. Acceptable formats are 11:22:33:44:aa:bb or 11223344aabb. Vendor wildcards are also supported. Acceptable formats are 11:22:33 or 112233 or 11:22:33:xx:xx:xx or 112233xxxxxx. Letters in MAC addresses can be upper or lower case.
description Description String No Max length = 255.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/macdevices/ Get all MAC devices.
GET /api/v1/macdevices/[id]/ Get specific MAC device with ID.
POST /api/v1/macdevices/ Create a new MAC device.
PATCH /api/v1/macdevices/[id]/ Update specific fields of specific MAC device with ID.

DELETE

/api/v1/macdevices/[id]/ Delete MAC device with ID.

Allowed filters

Field Lookup expressions Values
name exact, iexact, contains, icontains, startswith, istartswith  
address exact, iexact, contains, icontains, startswith, istartswith  

MAC devices (/macdevices/)

URL: https://[server_name]/api/v1/macdevices/

This endpoint represents the MAC device resource.

Supported fields

Field Display name Type Required Other restrictions
name MAC device name String Yes Max length = 50.
address MAC address String Yes Max length = 25. Must be a valid MAC address. Acceptable formats are 11:22:33:44:aa:bb or 11223344aabb. Vendor wildcards are also supported. Acceptable formats are 11:22:33 or 112233 or 11:22:33:xx:xx:xx or 112233xxxxxx. Letters in MAC addresses can be upper or lower case.
description Description String No Max length = 255.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/macdevices/ Get all MAC devices.
GET /api/v1/macdevices/[id]/ Get specific MAC device with ID.
POST /api/v1/macdevices/ Create a new MAC device.
PATCH /api/v1/macdevices/[id]/ Update specific fields of specific MAC device with ID.

DELETE

/api/v1/macdevices/[id]/ Delete MAC device with ID.

Allowed filters

Field Lookup expressions Values
name exact, iexact, contains, icontains, startswith, istartswith  
address exact, iexact, contains, icontains, startswith, istartswith