Plugins

francois2metz/freshping

GitHub
Overview
3Tables
Versions
GitHub
steampipe plugin install francois2metz/freshpingsteampipe plugin install francois2metz/freshping
On This Page
Documentation
Get started
Get Involved
Get Involved
Edit on GitHub
Discuss on Slack
Source Code
francois2metz/steampipe-plugin-freshping
License
Apache License 2.0
Version
v0.3.1
Published
18 Jul 2023

Freshping + Steampipe

Freshping is a monitoring service that is part of Freshworks.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
  id,
  name,
  url
from
  freshping_check;
+----+-----------------+------------------------------+
| id | name            | url                          |
+----+-----------------+------------------------------+
| 42 | Ca reste ouvert | https://caresteouvert.fr     |
| 43 | API             | https://api.caresteouvert.fr |
+----+-----------------+------------------------------+

Documentation

Get started

Install

Download and install the latest Freshping plugin:

steampipe plugin install francois2metz/freshping

Credentials

ItemDescription
CredentialsFreshping requires an API key.
PermissionsAPI tokens can create, update, delete and list checks.
RadiusEach connection represents a single freshping account.
Resolution1. Credentials explicitly set in a steampipe config file (~/.steampipe/config/freshping.spc)
2. Credentials specified in environment variables, e.g., FRESHPING_API_KEY.

Configuration

Installing the latest freshping plugin will create a config file (~/.steampipe/config/freshping.spc) with a single connection named freshping:

connection "freshping" {
    plugin = "francois2metz/freshping"


    # Freshping API Key
    # To get it:
    # 1. Login to your account
    # 2. Go to settings > Account settings
    # 3. Copy API Key
    # See https://support.freshping.io/en/support/solutions/articles/50000003709-freshping-api-documentation#Authentication
    # This can also be set via the `FRESHPING_API_KEY` environment variable.
    # api_key = "NoalNogitnazud1GranfairkyefAymvu"


    # Your freshping subdomain (for acme.freshping.io, enter acme)
    # This can also be set via the `FRESHPING_SUBDOMAIN` environment variable.
    # subdomain = ""
}

Credentials from Environment Variables

The Freshping plugin will use the following environment variables to obtain credentials only if other arguments (api_key or suddomain) are not specified in the connection:

export FRESHPING_API_KEY=NoalNogitnazud1GranfairkyefAymvu
export FRESHPING_SUBDOMAIN=acme

Get Involved