Documentation forServer & Application Monitor

API poller requirements

Before creating your first API poller, review this section about what's required.

  • Use an Orion account with Admin privileges.
  • Make sure SAM licenses are available — each monitored metric consumes a license.
  • Identify an existing managed SAM node to host the connection to the remote API.
    • Alternatively, create an external node to serve as an application endpoint for a service such as Azure. External nodes have fewer requirements; for example, no credentials are required at the node level.
    • If using the 30-day trial of SAM, you can use the node included in the evaluation version. However, note that API pollers are child contributors for enhanced node status calculations, so missing metrics will impact the status of that single node, which also serves as the Orion server and Main Polling Engine.

      HP ProLiant servers with an HP Integrated Lights-Out (iLO) REST API are not supported due to a known HP issue, even if this workaround is applied (© HP Enterprise Development LP, available at support.hpe.com, obtained on March 4, 2020).

In addition to SAM feature requirements, most remote APIs have their own requirements. Review API provider documentation (see these Useful APIs for SAM) to learn about types of data provided, where data is stored, and what you need to include in API requests, such as tokens.

Specifically, you'll need to determine:

  • The URL of the API
  • Defined endpoints where API data is available
  • Supported request URL formats
  • Authentication and authorization (credential) requirements
  • API rate limits

Some cloud services limit the amount of free API requests per calendar month and charge for extra requests in the remaining time frame. Check with your provider for details.