Skip to main content

Automated Diagnostics

Automated Diagnostics

SaaS & Internal Application APIs

A very common type of diagnostic job is to query an API as a way of measuring application or system health.
This could be a common SaaS API or might be querying the API of an internal application.

In either case, this is accomplished by using the HTTP Request workflow stepopen in new window, which can send an http request and trigger further steps based on the response code.
Whatever data is returned by the http step can be used in later steps in a workflow through the use of custom variablesopen in new window.

HTTP Request plugin can query external or internal APIs
HTTP Request plugin can query external or internal APIs

This plugin is very customizable to accommodate whatever is needed, including various authentication methods and support for proxy settings.

In addition to the HTTP Request Plugin, APIs can be queried using commands such as curl using the Command Step: Command Step to curl an endpoint