We use tracking cookies to understand how you use the product and help us improve it. Please accept cookies to help us improve. You can always opt out later via the link in the footer.
cloudquery
needs to be authenticated.
An API key is required for authentication.
See Authentication for API for more information.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: "v7.3.13"
tables:
- "snyk_audit_logs"
- "snyk_container_images"
- "snyk_custom_base_images"
- "snyk_issues"
- "snyk_organizations"
- "snyk_projects"
- "snyk_sbom"
destinations: ["postgresql"]
# Snyk specific configuration
# Learn more about the configuration options at https://cql.ink/snyk_source
spec:
# required
api_key: "${SNYK_API_KEY}"
# optional, default: all organizations accessible via `api_key`
organizations:
- "<YOUR_ORG_1>"
- "<YOUR_ORG_2>"
# optional, default: all projects accessible via `api_key`
projects:
- "<YOUR_PROJECT_1>"
- "<YOUR_PROJECT_2>"
api_key
(string
) (required)organizations
([]string
) (optional) (default: all organizations accessible via api_key
)projects
([]string
) (optional) (default: all projects accessible via api_key
)endpoint_url
(string
) (optional) (default: https://api.snyk.io/rest
)table_options
(Table Options spec) (optional)concurrency
(integer
) (optional) (default: 10000
)scheduler
(string
) (optional) (default: dfs
)
The scheduler to use when determining the priority of resources to sync.
Supported values are dfs
(depth-first search), round-robin
, shuffle
and shuffle-queue
.audit_logs
from
(string
in the format YYYY-MM-DD
) (optional)2022-01-01
.to
(string
in the format YYYY-MM-DD
) (optional)2024-12-31
.issues
created_after
(string
formatted as ISO 8601 timestamp) (optional)2022-01-01T01:00:01.000Z
.created_before
(string
formatted as ISO 8601 timestamp) (optional)2024-12-31T23:59:59.999Z
.updated_after
(string
formatted as ISO 8601 timestamp) (optional)2022-01-01T01:00:01.000Z
.updated_before
(string
formatted as ISO 8601 timestamp) (optional)2024-12-31T23:59:59.999Z
.${time:}
substitution will result in incremental syncs performing a full sync on each attempt.kind: source
spec:
name: snyk
path: cloudquery/snyk
registry: cloudquery
version: "v7.3.13"
tables:
- "snyk_audit_logs"
- "snyk_container_images"
- "snyk_custom_base_images"
- "snyk_issues"
- "snyk_organizations"
- "snyk_projects"
- "snyk_sbom"
destinations: ["postgresql"]
spec:
# required fields:
api_key: "${SNYK_API_KEY}"
# optional fields:
organizations:
- "<YOUR_ORG_1>"
- "<YOUR_ORG_2>"
projects:
- "<YOUR_PROJECT_1>"
- "<YOUR_PROJECT_2>"
endpoint_url: "api.snyk.io"
table_options:
audit_logs:
from: "2022-01-01"
to: "2024-12-31"
issues:
created_after: "2022-01-01T01:00:01.000Z"
created_before: "2024-12-31T23:59:59.999Z"
concurrency: 10000