SYNQ Scout Agent Configuration

Type: object

Configuration file format for the synq-scout SRE agent

 No Additional Properties

root synq
Type: object

SYNQConfig holds SYNQ platform connection settings.

 No Additional Properties

root synq client_id
Type: string

OAuth client ID for authenticating with the SYNQ platform.

root synq client_secret
Type: string

OAuth client secret for authenticating with the SYNQ platform.

root synq endpoint
Type: string

gRPC endpoint for the SYNQ API (e.g. "developer.synq.io:443").

root synq ingest_endpoint
Type: string

gRPC endpoint for the SYNQ ingest API. Defaults to Endpoint if empty.

root synq oauth_url
Type: string

OAuth token URL. Derived from Endpoint if empty.

root connections
Type: object

Each additional property must conform to the following schema

root connections Connection
Type: object

Connection is a single database connection entry in a connections map.

 No Additional Properties

root connections additionalProperties name
Type: string

Display name for this connection. Defaults to the connection ID (map key).

root connections additionalProperties disabled
Type: boolean

When true, the connection is skipped during execution.

root connections additionalProperties parallelism
Type: integer

Maximum number of parallel queries. Range: 1-256. Defaults to 8.

Value must be greater or equal to 1 and lesser or equal to 256

root connections additionalProperties postgres
Type: object

PostgresConf contains PostgreSQL connection parameters.

 No Additional Properties

root connections additionalProperties postgres port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties postgres allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties snowflake
Type: object

SnowflakeConf contains Snowflake connection parameters.

 No Additional Properties

root connections additionalProperties snowflake account
Type: string

Snowflake account identifier.

root connections additionalProperties snowflake warehouse
Type: string

Virtual warehouse to use for queries.

root connections additionalProperties snowflake role
Type: string

Role to assume after connecting.

root connections additionalProperties snowflake private_key
Type: string

PEM-encoded private key content for key-pair authentication.

root connections additionalProperties snowflake private_key_file
Type: string

Path to a PEM-encoded private key file.

root connections additionalProperties snowflake private_key_passphrase
Type: string

Passphrase to decrypt the private key.

root connections additionalProperties snowflake databases
Type: array of string

Databases to include. If empty, all accessible databases are scraped.

 No Additional Items

Each item of this array must be:

root connections additionalProperties snowflake databases databases items
Type: string

root connections additionalProperties snowflake use_get_ddl
Type: boolean

Use GET_DDL() to retrieve DDL for tables and views.

root connections additionalProperties snowflake account_usage_db
Type: string

Database containing the ACCOUNT_USAGE schema. Defaults to SNOWFLAKE.

root connections additionalProperties snowflake auth_type
Type: string

Set to "externalbrowser" to use SSO browser-based authentication.

root connections additionalProperties bigquery
Type: object

BigQueryConf contains BigQuery connection parameters.

 No Additional Properties

root connections additionalProperties bigquery project_id
Type: string

GCP project ID.

root connections additionalProperties bigquery region
Type: string

Region for BigQuery resources.

root connections additionalProperties bigquery service_account_key
Type: string

Inline JSON content of the service account key.

root connections additionalProperties bigquery service_account_key_file
Type: string

Path to the service account key JSON file.

root connections additionalProperties bigquery datasets
Type: array of string

Explicit list of dataset names to scrape. When set, only these datasets are queried
and project-level bigquery.datasets.list permission is not required.

 No Additional Items

Each item of this array must be:

root connections additionalProperties bigquery datasets datasets items
Type: string

root connections additionalProperties redshift
Type: object

RedshiftConf contains Amazon Redshift connection parameters.

 No Additional Properties

root connections additionalProperties redshift port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties redshift freshness_from_query_logs
Type: boolean

Estimate table freshness from Redshift query logs instead of metadata.

root connections additionalProperties mysql
Type: object

MySQLConf contains MySQL connection parameters.

 No Additional Properties

root connections additionalProperties mysql port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties mysql allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties mysql params
Type: object

Additional DSN parameters passed to the driver.

Each additional property must conform to the following schema

root connections additionalProperties mysql params additionalProperties
Type: string

root connections additionalProperties clickhouse
Type: object

ClickhouseConf contains ClickHouse connection parameters.

 No Additional Properties

root connections additionalProperties clickhouse port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties clickhouse database
Type: string

Database to connect to. If empty, all databases are scraped.

root connections additionalProperties clickhouse allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties trino
Type: object

TrinoConf contains Trino / Starburst connection parameters.

 No Additional Properties

root connections additionalProperties trino port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties trino use_plaintext
Type: boolean

Use a plain HTTP connection instead of HTTPS.

root connections additionalProperties trino catalogs
Type: array of string

Catalogs to include. Required for most Trino deployments.

 No Additional Items

Each item of this array must be:

root connections additionalProperties trino catalogs catalogs items
Type: string

root connections additionalProperties databricks
Type: object

DatabricksConf contains Databricks connection parameters.

 No Additional Properties

root connections additionalProperties databricks workspace_url
Type: string

Databricks workspace URL.

root connections additionalProperties databricks auth_token
Type: string

Personal access token for authentication.

root connections additionalProperties databricks auth_client
Type: string

OAuth client ID (M2M authentication).

root connections additionalProperties databricks auth_secret
Type: string

OAuth client secret (M2M authentication).

root connections additionalProperties databricks warehouse
Type: string

SQL warehouse ID to use for queries.

root connections additionalProperties mssql
Type: object

MSSQLConf contains Microsoft SQL Server / Azure SQL Database connection parameters.

 No Additional Properties

root connections additionalProperties mssql port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties mssql trust_cert
Type: boolean

Trust the server certificate without validation.

root connections additionalProperties mssql encrypt
Type: string

Encryption mode (e.g. "true", "false", "strict").

root connections additionalProperties mssql fed_auth
Type: string

Federated authentication method (e.g. "ActiveDirectoryDefault").

root connections additionalProperties mssql access_token
Type: string

Pre-acquired access token for Azure AD authentication.

root connections additionalProperties mssql application_client_id
Type: string

Azure AD application client ID for service principal auth.

root connections additionalProperties oracle
Type: object

OracleConf contains Oracle Database connection parameters.

 No Additional Properties

root connections additionalProperties oracle port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties oracle service_name
Type: string

Oracle service name.

root connections additionalProperties oracle ssl
Type: boolean

Enable SSL/TLS for the connection.

root connections additionalProperties oracle ssl_verify
Type: boolean

Verify the server's SSL certificate.

root connections additionalProperties oracle wallet_path
Type: string

Path to Oracle Wallet directory for authentication.

root connections additionalProperties oracle use_diagnostics_pack
Type: boolean

Enable Oracle Diagnostics Pack features (AWR, ASH).

root connections additionalProperties duckdb
Type: object

DuckDBConf contains DuckDB / MotherDuck connection parameters.

 No Additional Properties

root connections additionalProperties duckdb database
Type: string

File path, ':memory:' for in-memory, or MotherDuck database name.

root connections additionalProperties duckdb motherduck_account
Type: string

MotherDuck organization/account name (for cloud mode).

root connections additionalProperties duckdb motherduck_token
Type: string

MotherDuck authentication token (required for cloud MotherDuck).

root connections additionalProperties athena
Type: object

AthenaConf contains Amazon Athena connection parameters.

 No Additional Properties

root connections additionalProperties athena region
Type: string

AWS region hosting the Athena service and Glue Data Catalog.

root connections additionalProperties athena workgroup
Type: string

Athena workgroup. Defaults to "primary" when empty. Must have a
ResultConfiguration.OutputLocation configured.

root connections additionalProperties athena catalog
Type: string

Glue Data Catalog name. Defaults to "AwsDataCatalog" when empty.

root connections additionalProperties athena access_key_id
Type: string

Static AWS credentials. Pair accesskeyid with secretaccesskey.

root connections additionalProperties athena session_token
Type: string

Optional STS session token, when accesskeyid+secretaccesskey are
short-lived STS credentials.

root connections additionalProperties athena aws_profile
Type: string

Named AWS shared-config profile (from ~/.aws/credentials or
~/.aws/config). Used only when static credentials are absent.

root connections additionalProperties athena role_arn
Type: string

IAM role ARN to assume via STS. Wraps whichever base credentials
resolved above (or the host's default chain when no other auth is set).

root connections additionalProperties athena external_id
Type: string

External ID required by the role's trust policy. Pair with role_arn.

root connections additionalProperties athena role_session_name
Type: string

Optional STS session name. Defaults to "synq-athena".

root connections additionalProperties athena scope
Type: object

Scope filter for include/exclude filtering by Glue catalog, Glue
database, and table. Mapping: ScopeRule.database = Glue catalog,
ScopeRule.schema = Glue database, ScopeRule.table = Glue table/view.

 No Additional Properties

root connections additionalProperties athena scope include
Type: array

Include rules. If non-empty, only matching objects are accepted.

 No Additional Items

Each item of this array must be:

root connections additionalProperties athena scope include ScopeRuleConf
Type: object

ScopeRuleConf is a single include/exclude rule.

 No Additional Properties

root connections additionalProperties athena scope include include items database
Type: string

Database-level pattern (catalog for Athena/Trino/Databricks, project for BigQuery).

root connections additionalProperties athena scope include include items schema
Type: string

Schema-level pattern (Glue database for Athena, dataset for BigQuery).

root connections additionalProperties athena scope include include items table
Type: string

Table or view name pattern.

root connections additionalProperties athena scope exclude
Type: array

Exclude rules. Matching objects are rejected, even if they match an include rule.

 No Additional Items

Each item of this array must be:

root connections additionalProperties athena scope exclude ScopeRuleConf
Type: object

ScopeRuleConf is a single include/exclude rule.

Same definition as connections_additionalProperties_athena_scope_include_items

root connections additionalProperties athena use_show_create_table
Type: boolean

Use SHOW CREATE TABLE to retrieve full table DDL (CTAS bodies, Iceberg
TBLPROPERTIES, Hive external LOCATION/SerDe). One Athena query per
table — billed at the 10MB scan minimum each.

root connections additionalProperties athena use_show_create_view
Type: boolean

Use SHOW CREATE VIEW to retrieve full view DDL instead of the
rewritten body from informationschema.views.viewdefinition.

root connections additionalProperties athena use_iceberg_metrics_scan
Type: boolean

For Iceberg tables, fan out one Athena query per table to read row
count, total file size, snapshot commit timestamp, and partition
columns from the table's $files / $snapshots / $partitions metadata
tables. Hive externals are unaffected.

root llm
Type: object

YAMLLLMConfig contains LLM provider settings.

 No Additional Properties

root llm openai
Type: object

OpenAI-compatible API configuration (also used for LiteLLM proxy).

 No Additional Properties

root llm openai api_key
Type: string

API key for the LLM provider.

root llm openai base_url
Type: string

Base URL for the API (e.g. LiteLLM proxy URL).

root llm openai thinking_model
Type: string

Model used for deep thinking/analysis tasks.

root llm openai summary_model
Type: string

Model used for summarization tasks.

root llm triage_parallelism
Type: integer

Number of parallel triage operations.

root llm test_suggestions_parallelism
Type: integer

Number of parallel test suggestion operations.