REST API for domain level resources

FortiMail also supports retrieval and modification of domain level CMDB configuration settings. The API can be accessed using the following URL:

http(s)://host_ip/api/v1/domain/domain_name/resource_name/resource_id/sub_r esource_name/sub_resource_id/

It is very similar to the URL for system level resources, only two new tokens are added:

• domain: Required keyword, use to perform domain level queries
• domain_name: FQDN name of the domain to query (such as fortinet.com)

Examples:

• …/api/v1/domain/abc.com/ProfAntispam/: Returns list of antispam profiles for domain ‘abc.com’
• …/api/v1/domain/abc.com/PolicyRcpt/: Returns list of recipient based policies for domain ‘abc.com’
• …/api/v1/domain/abc.com/PolicyRecipient/1/: Returns details of recipient based policy ‘1’ for domain ‘abc.com’
• …/api/v1/domain/abc.com/UserPreference/: Returns list of entries in user preferences for domain ‘abc.com’

For a full list of domain level resources, refer to the Supported Resources List.