Search metadata extracted from the FortiAnalyzer API guide.

Use this before faz_raw_get or when a high-level tool does not cover an endpoint. Results include JSON-RPC methods, API paths, generated summaries, relative source paths, and public documentation URLs. Consult the linked source page for exact request parameters. The catalog is local and does not contact the appliance.

Show non-secret connection and safety configuration.

This does not make an appliance request and never returns credentials or session identifiers.

Get FortiAnalyzer version, model, hostname, license, disk, and memory status.

Get current FortiAnalyzer CPU, memory, and disk performance metrics.

List administrative domains, optionally returning only selected fields.

Get one ADOM. An empty ADOM uses FAZ_DEFAULT_ADOM.

List managed devices in an ADOM, optionally selecting response fields.

List devices that are visible to FortiAnalyzer but not registered.

List event-management alerts with bounded pagination.

Times are FortiAnalyzer-local values in YYYY-MM-DD HH:MM:SS form and must be supplied as a pair. filter_expression uses alert-filter syntax; prefer event_type and severity for common filters.

List basic and correlation event handlers in an ADOM.

List SQL report layouts in an ADOM.

List available report templates in an ADOM.

List configured SQL report schedules in an ADOM.

List global FortiAnalyzer log-forwarding configurations.

Start an asynchronous LogView search and return its task ID.

Device names are explicit; use ["All_FortiGate"] only intentionally. Supply start_time and end_time together for an absolute appliance-local range, otherwise last_n_hours is used. Call faz_get_log_search next.

Poll or fetch one page from a LogView task.

The task is deleted automatically only after FortiAnalyzer proves that this is the last page. A full page is retained conservatively because more rows may exist; fetch the next offset or call faz_cancel_log_search. Set cleanup_when_done=false whenever pagination is managed explicitly.

Cancel and delete a LogView task to release FortiAnalyzer resources.

Run a bounded LogView submit/poll/fetch/cleanup workflow.

This convenience tool returns one result page and always attempts to delete its server-side task on completion, timeout, or error. Failed cleanup stays tracked for a shutdown retry. For manual pagination, use faz_start_log_search and faz_get_log_search instead.

Call an appliance-local read endpoint not covered by a high-level tool.

First use faz_search_api_docs to find the candidate path, then consult its linked source page for parameter placement. Catalog membership is not enforced. params contains members beside url; credentials, session, request id, method, and host cannot be overridden. Results are returned without field-level redaction, and response size is controlled by the selected endpoint. Use only trusted endpoints and pass documented limit/range/field selectors when available.