Set up process #

brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync statuspage.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The CloudQuery Statuspage source plugin pulls data out of Statuspage and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from Statuspage, cloudquery needs to be authenticated and configured with valid API Key credentials. These are:

api_key
organization_id (optional)

Plugin Configuration Reference

Example #

This example syncs from Statuspage to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
# Common source-plugin configuration
spec:
  name: statuspage
  path: cloudquery/statuspage
  registry: cloudquery
  version: "v1.3.1"
  tables: 
    - "*"
  destinations: ["postgresql"]
  # Learn more about the configuration options at https://cql.ink/statuspage_source
  spec:
    # required parameters
    api_key: ${STATUSPAGE_API_KEY}
    
    # optional parameters
    # concurrency: 100
    # organization_id: ${STATUSPAGE_ORGANIZATION_ID}

Statuspage Spec #

This is the (nested) spec used by the source plugin.

api_key (string) (required) Statuspage API key
concurrency (integer) (optional) (default:100) The best effort maximum number of Goroutines to use. Lower this number to reduce memory usage.
organization_id (string) (optional) ID of the organization, needs to be fetched manually from Statuspage, required to sync users within the organization, their permissions for pages, etc.