GITBOOK-8008: MERGE IDE custom endpoint update wi option format chang…

…e to init cap
snyk · Sep 18, 2024 · 733c90c · 733c90c
1 parent 74f63fa
commit 733c90c
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 30 deletions.
diff --git a/...-plugins-and-extensions/eclipse-plugin/authentication-for-the-eclipse-plugin.md b/...-plugins-and-extensions/eclipse-plugin/authentication-for-the-eclipse-plugin.md
@@ -11,9 +11,9 @@ Snyk supports the following protocols for authentication:
 
 After the extension is installed, to authenticate follow these steps:
 
-1. In the dialog that opens, configure your Snyk region properly if you use Snyk on the EU and AU tenants, For more information, see [Regional hosting and data residency](../../../working-with-snyk/regional-hosting-and-data-residency.md#cli-and-ci-pipelines-urls).
+1. In the dialog that opens, set the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is `https://api.snyk.io`. For details, see [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
 
-<figure><img src="../../../.gitbook/assets/SCR-20240822-mgxw (1).png" alt="Snyk tenant configuration" width="563"><figcaption><p>Snyk tenant configuration</p></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/SCR-20240822-mgxw (1).png" alt="Snyk tenant configuration" width="563"><figcaption><p>Snyk endpoint configuration</p></figcaption></figure>
 
 2. On the next page with additional information, click **Finish**:
 

diff --git a/...de-plugins-and-extensions/eclipse-plugin/configuration-of-the-eclipse-plugin.md b/...de-plugins-and-extensions/eclipse-plugin/configuration-of-the-eclipse-plugin.md
@@ -6,7 +6,7 @@ You can set the following configuration options in the Snyk preferences.
 
 * `Snyk API Token`: Set the authentication token from Snyk.
 * `Path`: Specify your additions to the path to find needed third-party tools such as Gradle or Maven.
-* `Custom Endpoint`: Specify the custom endpoint for Single Tenant setups instead of `https://api.snyk.io`. See [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+* `Custom Endpoint`: Specify the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is `https://api.snyk.io`. For details, see [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
 * `Allow unknown certificate authorities`: Disable certificate checks for SSL connections.
 * `Snyk Open Source enabled`: Enable or Disable Snyk Open Source Dependency Scans through Language Server. Default: `Enabled` during beta
 * `Snyk Code enabled`: Enable or Disable Snyk Code Scans via Language Server. Default: `Disabled` during beta.

diff --git a/...gins/configuration-environment-variables-and-proxy-for-the-jetbrains-plugins.md b/...gins/configuration-environment-variables-and-proxy-for-the-jetbrains-plugins.md
@@ -6,20 +6,20 @@ After the plugin is installed, you can opt out of downloading the CLI through th
 
 You can set the following configurations for the plugin, using **Preferences → Tools → Snyk**:
 
-* **Token**: set the token that should be used for authentication with Snyk (see [Authentication for the JetBrains plugins](authentication-for-the-jetbrains-plugins.md)).
-* **Custom endpoint**: set the custom endpoint for the Snyk Web UI if needed. Use this field for single tenant setups as well, instead of https://api.snyk.io. See [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
-* **Ignore unknown CA**: ignore the SSL cert, if needed
-*   **Organization**: set the org to run `snyk test` against (similar to the `--org=` option in the CLI). Snyk recommends using the `ORG_ID`. If you specify an Organization slug name, the value must match the URL slug as displayed in the URL of your org in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`.
+* **Token**: Set the token that should be used for authentication with Snyk (see [Authentication for the JetBrains plugins](authentication-for-the-jetbrains-plugins.md)).
+* **Custom endpoint**: Specify the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is `https://api.snyk.io`. For details, see [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+* **Ignore unknown CA**: Ignore the SSL cert, if needed
+*   **Organization**: Set the org to run `snyk test` against (similar to the `--org=` option in the CLI). Snyk recommends using the `ORG_ID`. If you specify an Organization slug name, the value must match the URL slug as displayed in the URL of your org in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`.
 
     If not specified, the preferred Organization, as defined in your [web account settings](https://app.snyk.io/account), is used to run tests.
-*   **Additional parameters**: set additional `snyk test` [CLI options](https://docs.snyk.io/snyk-cli/cli-reference#options-for-multiple-commands) for Open Source scanning.
+*   **Additional parameters**: Set additional `snyk test` [CLI options](https://docs.snyk.io/snyk-cli/cli-reference#options-for-multiple-commands) for Open Source scanning.
 
     For **unmanaged** [**C/C++**](../../../supported-languages-package-managers-and-frameworks/c-c++/) **scanning**, use the CLI option `--unmanaged` to find vulnerabilities in open-source packages. This option works only for unmanaged C/C++ scanning; do not use this option for other languages. Additional parameters do not apply to Snyk Code or IaC.
-* **Snyk Open Source**: use to analyze the project for open source vulnerabilities through the CLI using Snyk Open Source; enabled by default.
-* **Snyk Infrastructure as Code**: use to analyze the project for insecure configurations in Terraform and Kubernetes code; enabled by default.
-* **Snyk Container vulnerabilities**: use to analyze the project for container vulnerabilities in container images and Kubernetes applications; enabled by default.
-* **Snyk Code Security issues**: use to analyze the project for security vulnerabilities in your application code using Snyk Code; enabled by default
-* **Snyk Code Quality issues**: applies to Snyk Code only; disabled by default.
+* **Snyk Open Source**: Use to analyze the project for open source vulnerabilities through the CLI using Snyk Open Source; enabled by default.
+* **Snyk Infrastructure as Code**: Use to analyze the project for insecure configurations in Terraform and Kubernetes code; enabled by default.
+* **Snyk Container vulnerabilities**: Use to analyze the project for container vulnerabilities in container images and Kubernetes applications; enabled by default.
+* **Snyk Code Security issues**: Use to analyze the project for security vulnerabilities in your application code using Snyk Code; enabled by default
+* **Snyk Code Quality issues**: Applies to Snyk Code only; disabled by default.
 * **Automatically manage needed binaries** and **Cli Path**: Opt out of downloading the CLI through the plugin and thus use your own installation of the CLI.
   * **CLI Path** specifies where the plugin searches for the CLI.
   * When **Automatically manage needed binaries** is checked, the plugin will download the CLI and updates regularly to the defined CLI Path. Uncheck this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules), and you need to obtain the CLI through other means.

diff --git a/...ions/visual-studio-code-extension/visual-studio-code-extension-configuration.md b/...ions/visual-studio-code-extension/visual-studio-code-extension-configuration.md
@@ -23,25 +23,25 @@ If you are behind a proxy, configure the proxy settings using VS Code proxy sett
 After the extension is installed, you can set the following configuration options for the extension. Note: Be sure to review the **Advanced** setting **Organization**.&#x20;
 
 * **Features**
-  * **Code Security**: configure if code security analysis should run over your code.
-  * **Code Quality**: configure if code quality analysis should run over your code.
-  * **Open Source Security**: configure if security analysis should run over your open source dependencies.
-  * **Infrastructure as Code**: configure if security analysis should run over your IaC configuration files.
-* **Severity**: set severity level to display in the analysis result tree.
-* **Crash Report**: send error reports to Snyk.
-* **Telemetry**: send usage statistics to Snyk.
-* **Scanning Mode:** run Snyk scans automatically in the background (Code and IaC)
+  * **Code Security**: Configure if code security analysis should run over your code.
+  * **Code Quality**: Configure if code quality analysis should run over your code.
+  * **Open Source Security**: Configure if security analysis should run over your open source dependencies.
+  * **Infrastructure as Code**: Configure if security analysis should run over your IaC configuration files.
+* **Severity**: Set severity level to display in the analysis result tree.
+* **Crash Report**: Send error reports to Snyk.
+* **Telemetry**: Send usage statistics to Snyk.
+* **Scanning Mode:** Run Snyk scans automatically in the background (Code and IaC)
 * **Advanced**
-  * **Auto Scan Open Source Security**: run Snyk Open Source analysis in automatic mode.
-  * **Additional Parameters**: set additional `snyk test` [CLI options](../../../snyk-cli/commands/test.md) for the Open Source scanning. For **unmanaged** [**C/C++**](../../../supported-languages-package-managers-and-frameworks/c-c++/) **scanning**, use the CLI option `--unmanaged` to find vulnerabilities in open-source packages. This option works only for unmanaged C/C++ scanning; do not use this option for other languages. For all .NET Projects, Snyk recommends adding the `--all-projects` additional parameter.\
+  * **Auto Scan Open Source Security**: Run Snyk Open Source analysis in automatic mode.
+  * **Additional Parameters**: Set additional `snyk test` [CLI options](../../../snyk-cli/commands/test.md) for the Open Source scanning. For **unmanaged** [**C/C++**](../../../supported-languages-package-managers-and-frameworks/c-c++/) **scanning**, use the CLI option `--unmanaged` to find vulnerabilities in open-source packages. This option works only for unmanaged C/C++ scanning; do not use this option for other languages. For all .NET Projects, Snyk recommends adding the `--all-projects` additional parameter.\
     Additional parameters do not apply to Snyk Code or Snyk IaC.
-  * **Organization**: specify an Organization to run tests for that Organization. Snyk recommends using `ORG_ID`. If you specify an Organization slug name, the value of the Organization setting `snyk.advanced.organization` must be the ORG slug as displayed in the URL of your org in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`. If not specified, the preferred Organization defined in your [web account settings](https://app.snyk.io/account) is used to run tests.
-  * **Custom endpoint**: specify the custom Snyk API endpoint for your Organization. Use this field for the custom endpoint for Single Tenant setups instead of https://api.snyk.io. The custom endpoint must be in the format `https://api.eu.snyk.io`. See [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
-  *   **Proxy Strict SSL:** check to specify that the proxy server certificate should be verified against the list of supplied CAs specific to Snyk Code.\
+  * **Organization**: Specify an Organization to run tests for that Organization. Snyk recommends using `ORG_ID`. If you specify an Organization slug name, the value of the Organization setting `snyk.advanced.organization` must be the ORG slug as displayed in the URL of your org in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`. If not specified, the preferred Organization defined in your [web account settings](https://app.snyk.io/account) is used to run tests.
+  * **Custom endpoint**: Specify the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is `https://api.snyk.io`. For details, see [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+  *   **Proxy Strict SSL:** Check to specify that the proxy server certificate should be verified against the list of supplied CAs specific to Snyk Code.\
       &#x20;&#x20;
 
       <figure><img src="../../../.gitbook/assets/image (1) (2) (1).png" alt="roxy strict SSL option"><figcaption><p>Proxy strict SSL option</p></figcaption></figure>
-  * **Automatic Dependency Management** and **Cli Path**: uncheck to opt out of downloading the CLI through the plugin and thus use your own installation of the CLI. Snyk recommends always using the most recent version of the CLI.
+  * **Automatic Dependency Management** and **Cli Path**: Uncheck to opt out of downloading the CLI through the plugin and thus use your own installation of the CLI. Snyk recommends always using the most recent version of the CLI.
     * When **Automatic Dependency Management** is checked, the plugin will automatically download and keep the CLI updated.
     *   When **Automatic Dependency Management** is not checked and **Cli Path** contains a path, the plugin uses the provided CLI path. Use this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules), and you need to obtain the CLI through other means.
 

diff --git a/...and-extensions/visual-studio-extension/visual-studio-extension-configuration.md b/...and-extensions/visual-studio-extension/visual-studio-extension-configuration.md
@@ -15,8 +15,8 @@ You can set the variables using the Web UI or on the command line using the `set
 
 After the plugin is installed, you can set the following configurations for the extension:
 
-* **Token**: Enter the token the extension uses to connect to Snyk. You can manually replace it, if you need to switch to another account.
-* **Custom endpoint**: Specify the custom Snyk API endpoint for your organization. Use this field for Single Tenant setups as well instead of https://app.snyk.io. See [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+* **Token**: Enter the token the extension uses to connect to Snyk. If you need to switch to another account, you can manually replace the token.
+* **Custom endpoint**: Specify the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is `https://api.snyk.io`. For details, see [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
 * **Ignore unknown CA**: Ignore unknown certificate authorities.
 * **Organization**: Specify the ORG\_ID to run Snyk commands tied to a specific organization. Snyk recommends using the ORG\_ID. If you specify the ORG\_NAME, that is, the organization slug name, the value must match the URL slug as displayed in the URL of your org in the Snyk UI: https://app.snyk.io/org/\[orgslugname]. If not specified, the Preferred Organization (as defined in your [account settings](https://app.snyk.io/account)) is used to run tests.
 * **Send usage analytics**: To help Snyk improve the extension, let your Visual Studio send Snyk information about how the extension is working.
@@ -25,7 +25,7 @@ After the plugin is installed, you can set the following configurations for the
 * **Scan all projects**: Auto-detect all projects in the working directory, enabled by default.
 * **Executable settings**: You can opt out of downloading the CLI through the plugin and thus use your own installation of the CLI.
   * When **Automatically manage needed binaries** is checked, the plugin automatically downloads the CLI and keeps the CLI updated.
-  *   When **Automatically manage needed binaries** is unchecked, you must provide a valid path to the CLI. Use this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules) and you need to obtain the CLI through other means. Snyk recommends recommends always using the most recent version of the CLI.
+  *   When **Automatically manage needed binaries** is unchecked, you must provide a valid path to the CLI. Use this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules) and you need to obtain the CLI through other means. Snyk recommends always using the most recent version of the CLI.
 
       <figure><img src="../../../.gitbook/assets/image (10) (1) (1) (1).png" alt=""><figcaption><p>VS Code extension executable settings</p></figcaption></figure>
 * **Solution Settings**: Set additional `snyk test` [CLI options](../../../snyk-cli/commands/test.md) for the Open Source scanning. For **unmanaged** [**C/C++**](../../../supported-languages-package-managers-and-frameworks/c-c++/) **scanning**, use the CLI option `--unmanaged` to find vulnerabilities in open-source packages. This requires **Scan all projects** to be disabled. The `--unmanaged` option works only for unmanaged C/C++ scanning; do not use this option for other languages. Additional parameters do not apply to Snyk Code or IaC.