SAM API Poller Template Guide
Download a PDF.
You can use the API Poller feature to monitor metrics via external REST APIs, providing an easier way to collect data from a modern application stack.
This guide describes how to use API poller templates to create API pollers on nodes that capture metrics for PaaS, IaaS, on-premises, and hybrid environments from Microsoft 365, Azure, VMware, Atlassian, and other APIs. Templates are also available to tighten SAM's integration with SolarWinds products such as AppOptics, Pingdom, and Service Desk.
New to REST APIs? Watch Intro to APIs for people who hate to program and API Pollers: When SNMP Won't Cut It.
To get started using an API Poller template:
- Review template requirements. For example, gather OAuth 2.0 Azure credentials to create an API poller based on the Microsoft Azure SQL Database API poller template.
- Navigate to the Node Details view for the node where you're assigning one or more templates.
- In the Management widget, click API Poller Management > Assign.
- When the Assign API Pollers wizard opens, select the template(s) you're adding and provide information, as prompted by the wizard. For details, see Assign API poller templates to nodes.
Periodically, SolarWinds updates API poller templates, as announced in SAM release notes. To determine the latest available version of a template, open the Assign API Pollers wizard.
Recreate any existing API pollers based on updated templates. Otherwise, polling stops and the following message may appear: "Bad request: Unexpected character following indexer."
Additional topics that may be useful include:
- API poller requirements
- API poller authorization and authentication
- Import API pollers into SAM
- Troubleshoot API monitoring in SAM
The following API poller templates are included in SAM:
- Artifactory Cloud health status API poller template
- Atlassian Bitbucket (Self-Hosted) license usage API poller template
- Atlassian Bitbucket (Self-Hosted) status API poller template
- Atlassian cloud health status API poller template
- Atlassian Confluence (Self-Hosted) license check API poller template
- Atlassian Confluence (Self-Hosted) status API poller template
- Atlassian Jira (Self-Hosted) license usage API poller template
- Atlassian Jira (Self-Hosted) status API poller template
- CircleCI health status API poller template
- GitHub health status API poller template
- JetBrains TeamCity API poller template
- Microsoft 365 Admin Center API poller template
- Microsoft 365 Email Application Statistics API poller template
- Microsoft 365 Exchange Mailboxes API poller template
- Microsoft 365 Exchange Online API poller template
- Microsoft 365 Group Statistics API poller template
- Microsoft 365 License Statistics API poller template
- Microsoft 365 Mail Traffic API poller template
- Microsoft 365 Mobile Device Management API poller template
- Microsoft 365 OneDrive API poller template
- Microsoft 365 SharePoint API poller template
- Microsoft 365 Teams API poller template
- Microsoft Azure Active Directory API poller template
- Microsoft Azure App Service API poller template
- Microsoft Azure Batch Account API poller template
- Microsoft Azure Blob Storage Account API poller template
- Microsoft Azure Event Hub Namespace API poller template
- Microsoft Azure IOT Hub API poller template
- Microsoft Azure SQL Database API poller template
- Microsoft Azure SQL Server Database Elastic Pool API poller template
- Microsoft Azure Synapse Analytics API poller template
- Microsoft Azure Virtual Machine Scale Set API poller template
- ServiceNow API poller template
- SolarWinds AppOptics Monitored Services API poller template
- SolarWinds Pingdom Transaction Checks API poller template
- SolarWinds SAM License Usage for Component-based licensing API poller template
- SolarWinds SAM License Usage for Node-based licensing API poller template
- SolarWinds Service Desk Incidents and Problems API poller template
- VMware API poller template
More templates are available in the SAM Content Exchange on THWACK, as posted by solarwinds_worldwide_llc
and tagged with an API Poller
label. See this example. After you download a template from THWACK, import it into SAM on the Manage API Pollers page and then use the Assign API Pollers wizard to create an API poller for a node.