FortiManager icon

FortiManager

Interact with FortiManager API

Firewall → List Address Groups

AI-generated

Summary

List address groups within a specified FortiManager domain.

Inputs

  • domain (required) — Domain of FortiManager API to operate on
  • adom (required) — Administrative Domain name
  • returnAll — Whether to return all results or use pagination
  • limit — Maximum number of address groups to return
  • filter — FortiManager filter syntax (e.g., "name==MyGroup")

Output shape

an array of address group objects

Pagination is controlled by returnAll and limit; filter can restrict results; on error an error object may be returned when continueOnFail is enabled.

Examples

Example 1: Retrieve all address groups in the default ADOM using default pagination

domain=pm, adom=root, additionalFields={returnAll=true}

Example 2: Get a limited set of address groups matching a specific name filter

domain=pm, adom=root, additionalFields={filter='name==MyGroup', limit=10}

Discussion