[Synthetics] Add proxy settings docs #3380
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔍 Preview links for changed docs |
vigneshshanmugam
approved these changes
Oct 7, 2025
| * If you `push` a Synthetics project that’s already been pushed using one Synthetics project ID and then try to `push` it using a *different* ID, it will create duplicates of all monitors in the Synthetics project. | ||
|
|
||
| `--proxy-uri` | ||
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project. |
There was a problem hiding this comment.
To Kibana right? can we call that out?
There was a problem hiding this comment.
Sure, good call 👍
mdbirnstiehl
approved these changes
Oct 8, 2025
| * If you `push` a Synthetics project that’s already been pushed using one Synthetics project ID and then try to `push` it using a *different* ID, it will create duplicates of all monitors in the Synthetics project. | ||
|
|
||
| `--proxy-uri` | ||
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project Kibana's. |
There was a problem hiding this comment.
Suggested change
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project Kibana's. | |
| : The proxy URL to be used when connecting to Kibana on your deployment or Observability Serverless project. |
| : API key used for [authentication](/deploy-manage/api-keys/elasticsearch-api-keys.md). | ||
|
|
||
| `--proxy-uri` | ||
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project Kibana's. |
There was a problem hiding this comment.
Suggested change
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project Kibana's. | |
| : The proxy URL to be used when connecting to Kibana on your deployment or Observability Serverless project. |
| This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||
|
|
||
| `--proxy-token` | ||
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` |
There was a problem hiding this comment.
Suggested change
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | |
| : (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==` |
| This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||
|
|
||
| `--proxy-token` | ||
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` |
There was a problem hiding this comment.
Suggested change
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | |
| : (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==` |
| : The Proxy URL to be used when connecting to the deployment or Observability Serverless project. | ||
|
|
||
| `token` (`string`) | ||
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` |
There was a problem hiding this comment.
Suggested change
| : (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | |
| : (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add proxy settings to synthetics cli docs