Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Products Best Practices Hardware Guides Products A-Z
Summary
By Solution
By 4D Pillars
By Cloud
All Products
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation Firewall
Web Application Firewall
Public Cloud
Private Cloud
FortiCloud
Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
    • More >>
    Unified SASE
  • Single Vendor SASE
  • Cloud Network Security
  • Secure Endpoint Connectivity
  • Web Application / API Protection
    • More >>
    Security Operations
  • Security Operations Automation
  • Identity
  • Early Detection & Prevention
    • More >>
    Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
  • Communication & Surveillance
    • Unified SASE
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Cloud Network Security
  • Cloud-Native Security
  • Web Application / API Protection
    • Security Operations
  • Security Operations Automation
  • Endpoint
  • Data Protection
  • Identity
  • Email
  • Early Detection & Prevention
  • Expert Services
  • Edge Firewall
  • Orchestration & management
  • SD Branch
  • Application Delivery
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Secure Private Access
  • Thin Edge
  • Identity
  • Application Gateway
  • Enterprise Asset Management
  • Endpoint Agent
  • Agentless Security Posture
  • Identity
  • Wireless
  • Switching
  • Identity
  • Privilege Acccess Management
  • Next Generation Firewall
  • Orchestration & management
  • Expert Services
  • Web Application / API Protection
  • All
  • All
  • Account Management
  • SAAS Management
  • SAAS Application Security
  • Managed Services
  • Platform as a service (PAAS)
  • Other SAAS Services
    • 4D Resources
    Solution Hubs
  • 4D Pillars
  • Cloud
  • Popular Solutions
    • All Products

    REST API Reference

    Home FortiRecorder 7.2.6 REST API Reference
    7.2.6
    7.2.6
    7.2.5
    7.2.4
    7.2.3
    7.2.2
    7.2.1
    7.2.0
    7.0.0
    6.4.0

    AiLog

    AiLog

    Logs messages by face recognition AI on FortiRecorder.

    Permissions required include Camera analytics.

    HTTP Methods

    • GET

    URL 
    https://HOST_OR_IP/api/v1/AiLog?type=activity&subtype=activity& range=TIMESTAMP&startIndex=INDEX&pageSize=ITEMS&start_time=TIMESTAMP&end_time=TIMESTAMP&person={user_id}&camera={camera_id}

    where variables are:

    • TIMESTAMP — Optional (except for range=TIMESTAMP, which is a fixed value). Timestamp in the format YYYY-MM-DD-HH-MM-SS (year, month, day, hour, minute, second).

    • INDEX — Optional. See also Filtering and paging.

    • PAGE_SIZE — Optional. See also Filtering and paging.

    • person — Either the name of a person profile, KNOWN (all known persons), or UNKNOWN (all unknown persons).

    • camera — Name of a camera. See also CameraCamera.

    Other parts of the URL are required, but their values cannot be changed.

    Example: Find times when unknown people were seen by camera MC51

    curl -X GET -b cookie.txt "https://HOST_OR_IP/api/v1/AiLog?Type=activity&subtype=activity&person=UNKNOWN&camera=MC51"
    Tooltip

    On Microsoft Windows with Command Prompt and the curl command, if the URL has parameters, then you must put double straight quotes ( " ) around the URL. If you do not, the command line may try to interpret URL parameters after each ampersand ( & ), question mark ( ? ), or asterisk/star ( * ) as commands or arguments. Errors at the end of the JSON indicate this problem but do not accurately show the cause, such as:

    'subtype' is not recognized as an internal or external command, operable program or batch file.

    Reserved characters and escape sequence vary by operating system and command line environment. Linux and Mac terminals often do not require this, and Microsoft PowerShell uses different escape sequences.
    Previous
    Next

    AiLog

    AiLog

    Logs messages by face recognition AI on FortiRecorder.

    Permissions required include Camera analytics.

    HTTP Methods

    • GET

    URL 
    https://HOST_OR_IP/api/v1/AiLog?type=activity&subtype=activity& range=TIMESTAMP&startIndex=INDEX&pageSize=ITEMS&start_time=TIMESTAMP&end_time=TIMESTAMP&person={user_id}&camera={camera_id}

    where variables are:

    • TIMESTAMP — Optional (except for range=TIMESTAMP, which is a fixed value). Timestamp in the format YYYY-MM-DD-HH-MM-SS (year, month, day, hour, minute, second).

    • INDEX — Optional. See also Filtering and paging.

    • PAGE_SIZE — Optional. See also Filtering and paging.

    • person — Either the name of a person profile, KNOWN (all known persons), or UNKNOWN (all unknown persons).

    • camera — Name of a camera. See also CameraCamera.

    Other parts of the URL are required, but their values cannot be changed.

    Example: Find times when unknown people were seen by camera MC51

    curl -X GET -b cookie.txt "https://HOST_OR_IP/api/v1/AiLog?Type=activity&subtype=activity&person=UNKNOWN&camera=MC51"
    Tooltip

    On Microsoft Windows with Command Prompt and the curl command, if the URL has parameters, then you must put double straight quotes ( " ) around the URL. If you do not, the command line may try to interpret URL parameters after each ampersand ( & ), question mark ( ? ), or asterisk/star ( * ) as commands or arguments. Errors at the end of the JSON indicate this problem but do not accurately show the cause, such as:

    'subtype' is not recognized as an internal or external command, operable program or batch file.

    Reserved characters and escape sequence vary by operating system and command line environment. Linux and Mac terminals often do not require this, and Microsoft PowerShell uses different escape sequences.
    Previous
    Next