Get Report Templates

Retrieve available report templates from FortiAnalyzer.

✅ All code examples tested: Verified against FortiAnalyzer v7.4.8, v7.6.4, v8.0.0.

Overview

This endpoint retrieves all report templates - useful for listing available pre-built and custom reports.

Endpoint Details

Method: POST URL: /jsonrpc API Path: /report/adom/{adom}/template ADOM Support: Yes Requires Authentication: Yes Minimum Version: 7.4.0

Request Example

REQUEST

{
    "method": "get",
    "params": [{
        "url": "/report/adom/root/template"
    }],
    "session": "{{session_id}}",
    "id": 1
}

RESPONSE

{
    "result": [{
        "data": [
            {
                "name": "Daily_Traffic_Report",
                "description": "Daily traffic summary",
                "type": "sql-report"
            }
        ],
        "status": {
            "code": 0,
            "message": "OK"
        }
    }]
}

Complete Python Example

import requests
import urllib3

urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

def get_report_templates(session_id, adom="root"):
    """Get available report templates"""
    url = "https://faz.example.com/jsonrpc"
    
    payload = {
        "method": "get",
        "params": [{
            "url": f"/report/adom/{adom}/template"
        }],
        "session": session_id,
        "id": 1
    }
    
    response = requests.post(url, json=payload, verify=False)
    result = response.json()
    
    if result['result'][0]['status']['code'] == 0:
        return result['result'][0]['data']
    else:
        raise Exception(f"API error: {result['result'][0]['status']['message']}")

# Example
templates = get_report_templates(session_id="your_session_id")
for template in templates:
    print(f"Template: {template['name']}")
    print(f"  Description: {template.get('description', 'N/A')}")

---

Last Updated: 2025-11-10 API Version: 7.6.4+