Back to plugin list
snyk
Official
Premium

Snyk

The CloudQuery Snyk plugin pulls configuration out of Snyk resources and loads it into any supported CloudQuery destination

Publisher

cloudquery

Latest version

v5.2.0

Type

Source

Platforms
Date Published

Nov 9, 2023

Price per 1M rows

$100

free quota

1M rows

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 snyk.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview

The CloudQuery Snyk plugin pulls configuration out of Snyk resources and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication

In order to fetch information from Snyk, cloudquery needs to be authenticated. An API key is required for authentication. See Authentication for API for more information.

Snyk Source Plugin Configuration Reference

Example

This example syncs from Snyk to a Postgres destination, using api_key authentication. The (top level) source spec section is described in the Source Spec Reference.
kind: source
# Common source-plugin configuration
spec:
  name: snyk
  path: cloudquery/snyk
  registry: cloudquery
  version: "v4.0.0"
  tables: ["*"]
  destinations: ["postgresql"]

  # Snyk specific configuration
  spec:
    api_key: "<YOUR_API_KEY_HERE>"
    organizations:
    - "<YOUR_ORG_1>"
    - "<YOUR_ORG_2>"
    endpoint_url: "<YOUR_BASE_URL>"
    table_options:
      snyk_reporting_issues:
        period: 30d

    # Optional parameters:

Snyk Spec

This is the (nested) spec used by the Snyk source plugin.
  • api_key (string) (required)
    An API key to access Snyk resources. See Authentication for API for more information.
  • organizations ([]string) (optional) (default: all organizations accessible via api_key)
    You can choose to limit what organizations to sync information from.
  • endpoint_url (string) (optional)
    Endpoint URL to make the API requests to.
  • retries (integer) (optional) (default: 10)
    Number of retries to make when a request fails with a retryable error code.
  • retry_delay_seconds (integer) (optional) (default: 65)
    Number of seconds to wait between retries. Jitter is added to this value.
  • table_options (Table Options spec) (optional)
    Options to apply to specific tables. See [Table Options](#Table Options) for more information.
  • concurrency (integer) (optional) (default: 10000)
    Amount of concurrent request that may be issued to Snyk API.

Snyk Table Options Spec

  • snyk_reporting_issues
    • period (string) (optional) (default: 30d)
      The period of time to use when querying for issues, relative to current time. This is always relative to current time, and cannot be used in conjunction with from and to.
      Examples: 30d (30 days), 2w (2 weeks).
    • from (string) (optional)
      The start of the period of time to use when querying for issues.
      Examples: 2021-01-01.
    • to (string) (optional)
      The end of the period of time to use when querying for issues.
      Examples: 2021-01-01.


Subscribe to product updates

Be the first to know about new features.