fix: add empty format details for endpoint url

ngrok · Sep 26, 2024 · 49ae01d · 49ae01d
1 parent f38fc8d
commit 49ae01d
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/docs/agent/config/v3.mdx b/docs/agent/config/v3.mdx
@@ -305,7 +305,7 @@ ngrok start --all
 | Name                                                 | Required | Protocols   | Description                                                                                                                                                            |
 | ---------------------------------------------------- | -------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [`name`](#name)                                      | Required |             | A unique name for this endpoint's configuration.                                                                                                                       |
-| [`url`](#url)                                        | Required |             | The address you would like to use to forward traffic to your upstream service.                                                                                         |
+| [`url`](#url)                                        |          |             | The address you would like to use to forward traffic to your upstream service. Leave empty to get a randomly assigned address.                                                                                        |
 | [`metadata`](#metadata-1)                            |          |             | An arbitrary string of user-defined metadata for this endpoint.                                                                                                        |
 | [`description`](#description)                        |          |             | An arbitrary user-defined description about this endpoint.                                                                                                             |
 | [`traffic_policy`](#traffic-policy)                  |          |             | Accepts a Traffic Policy configuration in YAML format.                                                                                                                 |
@@ -340,7 +340,9 @@ String. The address you would like to use to forward traffic to your upstream se
 - **Origin** - `https://example.ngrok.app` _or_ `https://example.ngrok.app:443`
   - When using the _origin_ format you are defining the protocol, domain and port.
 - **Scheme (shorthand)** - `https://`
-  - When using _scheme_ you are defining the protocol and will receive back a randomly generated ngrok domain.
+  - When using _scheme_ you are defining the protocol and will receive back a randomly assigned ngrok address.
+- **Empty** - ``
+  - When _empty_ your endpoint will default to be `https` and receive back a randomly assigned ngrok address.
 
 ##### Example