Documentation forServer & Application Monitor

Add API pollers in SAM

Here is an overview of steps involved in adding an API poller:

  • Provide details about your new API poller:
    • Select a request method: GET or POST.
    • Configure a name and description for the API poller.
    • Provide the URL of the remote API.
    • Specify the type of authorization used by the API.
    • Enter credentials, if required by the remote API.
  • Send an initial API to retrieve a list of available metrics.
  • Select the values you want to monitor:
    • Review the API response to determine which metrics are available.
    • Select the metrics you want to monitor.
    • Assign Orion Web Console display names for returned to metrics.
    • (Optional) Configure warning and/or critical thresholds.
  • Save your new API poller.

Out-of-the-box templates designed for Microsoft 365, Azure, Atlassian, VMware, and SolarWinds APIs are also available, as listed in the SAM API Poller Template Guide. See also Assign API poller templates to nodes.

To create an API poller for a node:

  1. Review API poller requirements. For example, you'll need to specify an existing node.
  2. Click Settings > All Settings > Manage API Pollers.
  3. When the Manage API Poller page appears:
    1. Click New.
    2. Click the row for the node where you're adding the API poller.
    3. Click Create API Poller.

  4. At the top of the API Poller page, select a Method for the request. The default is GET, which retrieves data from an external API.

  5. Enter the Request URL of the API.
    Starting in SAM 2020.2, you can use macros in request URLs; for example,${IpAddress}.
    For APIs that do not require authentication, skip ahead to step 8 and click Send Request.
  6. Click Configure to open the API Poller settings dialog box.  
    1. Provide a Name and (optional) Description.

      If you do not provide a name for an API poller, related data is not displayed in PerfStack.

    2. (Optional) Disable SSL certificate verification.

      SAM checks for a valid SSL certificate during API requests, by default. For remote API servers without valid certificates, disable this option.

    3. (Optional) Enable existing Orion settings for proxy servers.
    4. (Optional) Set a custom polling interval.
    5. Select the Authorization used by the API.
    6. Provide credentials, if required.

      Starting in SAM 2020.2.5, you can manage API poller credentials on the Manage Credentials page.

    7. Click Save.

  7. If the API requires specific details in the header (for example, credentials), add them. Click + to add multiple headers.

    Headers are not encrypted; they're stored in the database as plain text.

  8. Click Send Request.

    This initial API request is sent from the web. Afterward, API polling occurs via the Main Polling Engine (usually the Orion server) or an Additional Polling Engine, depending on the node configuration.

    When the Response appears, a Monitor () icon appears next to each metric you can monitor. An Expand () icon indicates that additional metrics can be monitored. The following example shows that 13 more metrics are available.

    A Response status code other than 200 indicates the request failed. Verify API poller settings, make sure the remote API is available, and click Send Request again. See also Troubleshoot API pollers in SAM.

  9. For each value you want to retrieve from the API, click the Monitor () icon to open the "Configure a value to monitor" dialog box.

    1. Leave "How should we store this value?" set to "New monitored value" to add only the current metric.

      Select "Use as a variable in subsequent request" to use the value for this API poller only. It will not be stored in the database or consume a SAM license. This is useful for APIs that require authentication tokens in headers; the first request retrieves a token that is then passed to subsequent requests as a variable in headers. See Chain multiple API requests in a single API poller in SAM for details.

    2. Enter an Orion display name for the metric.
    3. For Type, the default value is Numeric. If necessary, change it to String and then use the extra fields that appear to map string values to numeric values. For example, map "True" to 1 and "False" to 2. See API poller alerts for details.
    4. (Optional) Set Warning and/or Critical threshold values. See API poller alerts for details.
    5. Click Save.
  10. When finished selecting and configuring values to monitor, click Save to finish creating the API poller.

If errors occur when saving an API poller, review OrionWeb.Log and ApolloWebApi.log files.

When you return to the Node Details view, wait 2 minutes for polling to occur. When monitored metrics appear in the API Poller widget, you can:

  • Click the title of a metric display only data for that metric in PerfStack.
  • Click an API poller name to display all collected metrics in PerfStack.