LogoDark mode logo
LogoDark mode logo
Contact SupportLoading Light/Dark Toggle

    • Azure Application Insights provider
    • Azure Log Analytics provider
    • Elasticsearch provider
    • Google API provider
    • Microsoft Entra ID provider
    • PagerDuty provider
    • Pingdom provider
    • Prometheus provider
    • ServiceNow provider
    • SolarWinds provider
    • Splunk provider
    • SquaredUp Cloud Provider
    • Uptime Robot provider
    • Web API provider
  • How to integrate and visualize your external data
  • How to create a dashboard
  • Recycle Bin
  • Working with perspectives
  • Action buttons for dashboards and perspectives
  • VADA perspective
  • How to scope tiles
  • Timeframes for tiles
  • Grid Designer
  • Performance Metric Labels
  • How to use wildcards in metrics
  • How to show multiple metrics on one graph (v4.2 and below)
  • How to use Custom Labels
  • How to use criteria when scoping alerts
  • How to use criteria when scoping objects
  • How to run SCOM tasks
  • How to enable graph color matching
  • Sharing Dashboards with anyone - Open Access

dashboardingintegrations web api provider

Web API provider

An EAM-X edition license is required for this feature. To upgrade please contact [email protected]

What are Integrations?

SquaredUp DS Integrations allow you to create your own providers. Each Integration has its own form to help you input the information required for different providers.

What is a provider?

Providers contain the connection details to external platforms. A provider only needs to be set up once and can then be used when creating tiles on a dashboard.

There are two types of integrations and therefore providers:

  • generic Web API providers that can connect to any REST API
  • dedicated providers that connect to a specific external platform or database (SQL, ServiceNow, Azure Active App Insights, Elasticsearch, etc.)

About Web API providers

The Web API integration allows you to create Web API providers. A Web API provider is a generic provider that contains the connection details to any REST API that returns JSON.

Which Integrations can I use for Web API tiles?

You can use generic and dedicated integrations to create your own providers. Of course, a dedicated provider like ServiceNow will only work with the ServiceNow API.

You need to have at least one provider before you can use Web API tiles (see How to use the Web API tile).

The Simple Web API provider has been created for you, and can be used by entering a URL and parameters on the fly in the Web API tile on a tile by tile basis. If you are going to create several tiles using a particular API we recommend you create your own API provider so you only need to configure it once.

Generic Web API providers

Simple

No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).

Basic auth

Basic authentication. Your specified username and password will be Base64 encoded automatically.

OAuth

Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service.

Walkthroughs for creating generic Web API providers for popular APIs

PagerDuty provider

Pingdom provider

Google API provider (such as Google Analytics)

Uptime Robot

Dedicated providers

Microsoft Entra ID
When using Microsoft Entra ID authentication with an app or service
How to add a Microsoft Entra ID provider
Azure Application Insights
How to add an Azure Application Insights provider
Azure Log Analytics
How to add an Azure Log Analytics provider
ServiceNow
How to add a ServiceNow provider
Elasticsearch
How to add an Elasticsearch provider
Splunk
How to add a Splunk provider

Adding a Web API provider

  1. In SquaredUp DS navigate to the right-hand menu ☰ > system > Integrations

  2. Under Integrations click on Web API and choose either Simple, Basic Auth or OAuth depending on the API you are using.

    Simple

    No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).

    Basic auth

    Basic authentication. Your specified username and password will be Base64 encoded automatically.

    OAuth

    Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service.

    Note: When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure SquaredUp DS to use a proxy.
  3. Complete the provider fields, using your API provider's online documentation as a guide.

    ignore invalid ssl: Turn the on/off switch to on if you are using a self-signed certificate.

    default headers headers sent with all requests using this provider, for example the API token in the format the API requires.

    url parameters url parameters sent with all requests using this provider. For example, a query parameter that is always used can be added here in the provider to save adding it to every dashboard configuration.

  4. You are now ready to use this provider in a Web API tile (see How to use the Web API tile).

Further help for adding Web API providers

  • Blog: Integrating SquaredUp DS with external APIs: UptimeRobot
  • Webinar that includes New Relic

For other APIs, take a look at our Community Answers site, where there's a wealth of knowledge about APIs.

Was this article helpful?


Have more questions or facing an issue?
Submit a ticket

On this page

  • About Web API providers
  • Adding a Web API provider
  • Further help for adding Web API providers

Footer

Sites

  • SQUAREDUP
  • SQUAREDUP DS
  • DOWNLOAD
  • COMMUNITY ANSWERS

Quick Links

  • SUBMIT A REQUEST
  • EVENTS
  • CAREERS

Small Print

  • PRIVACY POLICY
  • TERMS AND CONDITIONS
Youtubex (Twitter)LinkedIn

© SquaredUp 2025