https://github.com/theapsgroup/steampipe-plugin-freshservice
Use SQL to instantly query FreshService tickets, assets and more. Open source CLI. No DB required.
https://github.com/theapsgroup/steampipe-plugin-freshservice
freshservice golang postgres postgresql postgresql-fdw sql steampipe steampipe-plugin
Last synced: about 2 months ago
JSON representation
Use SQL to instantly query FreshService tickets, assets and more. Open source CLI. No DB required.
- Host: GitHub
- URL: https://github.com/theapsgroup/steampipe-plugin-freshservice
- Owner: theapsgroup
- License: apache-2.0
- Created: 2022-01-05T15:43:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-02T08:30:06.000Z (over 2 years ago)
- Last Synced: 2024-06-19T13:47:10.128Z (almost 2 years ago)
- Topics: freshservice, golang, postgres, postgresql, postgresql-fdw, sql, steampipe, steampipe-plugin
- Language: Go
- Homepage: https://hub.steampipe.io/plugins/theapsgroup/freshservice
- Size: 1.13 MB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FreshService plugin for Steampipe
Use SQL to query information including Tickets, Agents, Assets and more from FreshService.
- **[Get started →](https://hub.steampipe.io/plugins/theapsgroup/freshservice)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/theapsgroup/freshservice/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/theapsgroup/steampipe-plugin-freshservice/issues)
## Quick start
Install the plugin with [Steampipe](https://steampipe.io):
```shell
steampipe plugin install theapsgroup/freshservice
```
Setup the configuration:
```shell
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-corp` if your instance is `https://my-corp.freshservice.com`)
- `FRESHSERVICE_TOKEN` : The API Key / Token to use.
Run a query:
```sql
select
id,
name,
active,
category
from
freshservice_sla_policy;
```
## Developing
Prerequisites:
- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)
- [FreshService](https://freshservice.com/)
Clone:
```sh
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:
```shell
make
```
Configure the plugin:
```
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/freshservice.spc
```
Try it!
```
steampipe query
> .inspect freshservice
```
Further reading:
- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)