Fortinet black logo

Integration API Guide

Get Agent Status for a Specific Host

Get Agent Status for a Specific Host

This API enables you to get Linux and Windows Agent status.

Release Added

5.2.5

Methodology REST API based: Caller makes an HTTPS request with query parameters: orgId, hostName.
Request URL https://<FortiSIEM_Supervisor_IP>/phoenix/rest/agentStatus/all?request=<orgId>,<hostName>
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account that has the appropriate access. Use "super" as the organization for Enterprise deployments.
    Curl example: curl -k -u super/admin:Admin*123
  • Service Provider deployments: User name and password of Super Global account or Organization specific account and name. Make sure that the account has the appropriate access.
    Curl example with super organization: curl -k -u super/admin:Admin*123
    If querying for a specific organization, replace "super" with the organization name.
Input Parameters Query parameters: orgId, hostName.
Output An XML file containing Type, AgentStatus, PolicyID, HeartbeatTime, LastEventReceiveTime

Refer to Example Usage to get the list of monitored devices and attributes.

Get Agent Status for a Specific Host

This API enables you to get Linux and Windows Agent status.

Release Added

5.2.5

Methodology REST API based: Caller makes an HTTPS request with query parameters: orgId, hostName.
Request URL https://<FortiSIEM_Supervisor_IP>/phoenix/rest/agentStatus/all?request=<orgId>,<hostName>
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account that has the appropriate access. Use "super" as the organization for Enterprise deployments.
    Curl example: curl -k -u super/admin:Admin*123
  • Service Provider deployments: User name and password of Super Global account or Organization specific account and name. Make sure that the account has the appropriate access.
    Curl example with super organization: curl -k -u super/admin:Admin*123
    If querying for a specific organization, replace "super" with the organization name.
Input Parameters Query parameters: orgId, hostName.
Output An XML file containing Type, AgentStatus, PolicyID, HeartbeatTime, LastEventReceiveTime

Refer to Example Usage to get the list of monitored devices and attributes.