FreshService plugin for Steampipe

Use SQL to query information including Tickets, Agents, Assets and more from FreshService.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install theapsgroup/freshservice

Setup the configuration:

vi ~/.steampipe/config/freshservice.spc

or set the following Environment Variables

• FRESHSERVICE_DOMAIN : The friendly sub-domain at which your instance is deployed (example: my-corpif your instance ishttps://my-corp.freshservice.com`)
• FRESHSERVICE_TOKEN : The API Key / Token to use.

Run a query:

select
  id,
  name,
  active,
  category
from
  freshservice_sla_policy;

Developing

Prerequisites:

• Steampipe
• Golang
• FreshService

Clone:

git clone https://github.com/theapsgroup/steampipe-plugin-freshservice.git
cd steampipe-plugin-freshservice

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/freshservice.spc

Try it!

steampipe query
> .inspect freshservice

Further reading:

• Writing plugins
• Writing your first table