Skip to content

Commit 328c3e6

Browse files
S3PrototypeS3Prototype
committed
Update with main
1 parent 01ef9ac commit 328c3e6

File tree

569 files changed

+112
-11879
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

569 files changed

+112
-11879
lines changed

‎agent/api.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The ngrok agent API guarantees that breaking changes to the API will never be ma
4848

4949
<Note>
5050

51-
The ngrok agent API accessible at `http://localhost:4040/api` supports only the v2 agent configuration format. If you are using or planning to use configuration version 3, refer to the [Agent Config Version 3](https://ngrok.com/docs/agent/config/v3/) documentation for guidance.
51+
The ngrok agent API accessible at `http://localhost:4040/api` supports only the v2 agent configuration format. If you are using or planning to use configuration version 3, refer to the [Agent Config Version 3](/agent/config/v3/) documentation for guidance.
5252

5353
</Note>
5454

‎agent/changelog.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebarTitle: Changelog
77

88
### ngrok agent 3.30.0 \[2025-09-23\]
99

10-
- A new agent HTTP API, `/api/endpoints`, has been introduced that corresponds to the [agent config version 3 format](https://ngrok.com/docs/agent/config/v3/)
10+
- A new agent HTTP API, `/api/endpoints`, has been introduced that corresponds to the [agent config version 3 format](/agent/config/v3/)
1111
- Endpoints and tunnels deleted via the agent API will be properly reflected in the Dashboard
1212

1313
### ngrok agent 3.29.0 \[2025-09-17\]

‎agent/cli-api.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8037,10 +8037,10 @@ ngrok api tls-certificates create [flags]
80378037

80388038
| Flag | Description |
80398039
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
8040-
| `--certificate-pem` | chain of PEM-encoded certificates, leaf first. See Certificate Bundles (https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
8040+
| `--certificate-pem` | chain of PEM-encoded certificates, leaf first. See Certificate Bundles (https://ngrok.com/docs/universal-gateway/http#certificate-chains). |
80418041
| `--description` | human-readable description of this TLS certificate. optional, max 255 bytes. |
80428042
| `--metadata` | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
8043-
| `--private-key-pem` | private key for the TLS certificate, PEM-encoded. See Private Keys (https://ngrok.com/docs/cloud-edge/endpoints#private-keys). |
8043+
| `--private-key-pem` | private key for the TLS certificate, PEM-encoded. See Private Keys (https://ngrok.com/docs/universal-gateway/http#private-keys). |
80448044
| `--api-key` | API key to use |
80458045
| `--config` | path to config files; they are merged if multiple |
80468046
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |

‎api/resources/tls-certificates.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ POST /tls_certificates
3232
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
3333
| `description` | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
3434
| `metadata` | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
35-
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
36-
| `private_key_pem` | string | private key for the TLS certificate, PEM-encoded. See [Private Keys](https://ngrok.com/docs/cloud-edge/endpoints#private-keys). |
35+
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](/universal-gateway/http#certificate-chains). |
36+
| `private_key_pem` | string | private key for the TLS certificate, PEM-encoded. See [Private Keys](/universal-gateway/http#private-keys). |
3737

3838
### Response
3939

@@ -50,7 +50,7 @@ Returns a 201 response on success
5050
| `created_at` | string | timestamp when the TLS certificate was created, RFC 3339 format |
5151
| `description` | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
5252
| `metadata` | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
53-
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
53+
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](/universal-gateway/http#certificate-chains). |
5454
| `subject_common_name` | string | subject common name from the leaf of this TLS certificate |
5555
| `subject_alternative_names` | [TLSCertificateSANs](#tlscertificatesans-fields) | subject alternative names (SANs) from the leaf of this TLS certificate |
5656
| `issued_at` | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
@@ -113,7 +113,7 @@ Returns a 200 response on success
113113
| `created_at` | string | timestamp when the TLS certificate was created, RFC 3339 format |
114114
| `description` | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
115115
| `metadata` | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
116-
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
116+
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](/universal-gateway/http#certificate-chains). |
117117
| `subject_common_name` | string | subject common name from the leaf of this TLS certificate |
118118
| `subject_alternative_names` | [TLSCertificateSANs](#tlscertificatesans-fields) | subject alternative names (SANs) from the leaf of this TLS certificate |
119119
| `issued_at` | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
@@ -170,7 +170,7 @@ Returns a 200 response on success
170170
| `created_at` | string | timestamp when the TLS certificate was created, RFC 3339 format |
171171
| `description` | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
172172
| `metadata` | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
173-
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
173+
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](/universal-gateway/http#certificate-chains). |
174174
| `subject_common_name` | string | subject common name from the leaf of this TLS certificate |
175175
| `subject_alternative_names` | [TLSCertificateSANs](#tlscertificatesans-fields) | subject alternative names (SANs) from the leaf of this TLS certificate |
176176
| `issued_at` | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
@@ -227,7 +227,7 @@ Returns a 200 response on success
227227
| `created_at` | string | timestamp when the TLS certificate was created, RFC 3339 format |
228228
| `description` | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
229229
| `metadata` | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
230-
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains). |
230+
| `certificate_pem` | string | chain of PEM-encoded certificates, leaf first. See [Certificate Bundles](/universal-gateway/http#certificate-chains). |
231231
| `subject_common_name` | string | subject common name from the leaf of this TLS certificate |
232232
| `subject_alternative_names` | [TLSCertificateSANs](#tlscertificatesans-fields) | subject alternative names (SANs) from the leaf of this TLS certificate |
233233
| `issued_at` | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |

‎api/resources/tunnels.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Returns a 200 response on success
4141
| `id` | string | unique tunnel resource identifier |
4242
| `public_url` | string | URL of the ephemeral tunnel's public endpoint |
4343
| `started_at` | string | timestamp when the tunnel was initiated in RFC 3339 format |
44-
| `metadata` | string | user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#common-tunnel-configuration-properties) In API version 0, this value was instead pulled from the top-level [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#metadata). |
44+
| `metadata` | string | user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](/agent/config#common-tunnel-configuration-properties) In API version 0, this value was instead pulled from the top-level [metadata configuration option](/agent/config#metadata). |
4545
| `proto` | string | tunnel protocol for ephemeral tunnels. one of `http`, `https`, `tcp` or `tls` |
4646
| `region` | string | identifier of tune region where the tunnel is running |
4747
| `tunnel_session` | [Ref](#ref-fields) | reference object pointing to the tunnel session on which this tunnel was started |
@@ -80,7 +80,7 @@ Returns a 200 response on success
8080
| `id` | string | unique tunnel resource identifier |
8181
| `public_url` | string | URL of the ephemeral tunnel's public endpoint |
8282
| `started_at` | string | timestamp when the tunnel was initiated in RFC 3339 format |
83-
| `metadata` | string | user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#common-tunnel-configuration-properties) In API version 0, this value was instead pulled from the top-level [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#metadata). |
83+
| `metadata` | string | user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](/agent/config#common-tunnel-configuration-properties) In API version 0, this value was instead pulled from the top-level [metadata configuration option](/agent/config#metadata). |
8484
| `proto` | string | tunnel protocol for ephemeral tunnels. one of `http`, `https`, `tcp` or `tls` |
8585
| `region` | string | identifier of tune region where the tunnel is running |
8686
| `tunnel_session` | [Ref](#ref-fields) | reference object pointing to the tunnel session on which this tunnel was started |

‎getting-started/cloud-endpoints-quickstart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,6 @@ You configured a basic traffic policy to forward requests from one endpoint to a
351351
What else can you do with these features?
352352

353353
- See [the cloud endpoints overview](/universal-gateway/cloud-endpoints/#use-cases) to learn more about use cases, how they compare to agent endpoints, and more.
354-
- If you need to interact with cloud endpoints programmatically, check out ngrok's [API client libraries](https://ngrok.com/docs/api/#client-libraries).
354+
- If you need to interact with cloud endpoints programmatically, check out ngrok's [API client libraries](/api/#client-libraries).
355355
- See [Load Balancing with Cloud Endpoints](/universal-gateway/cloud-endpoints/forwarding-and-load-balancing/) to learn how to distribute traffic across multiple internal endpoints.
356356
- This quickstart barely scratches the surface of what's possible with a traffic policy—check out the [Actions overview](/traffic-policy/actions/) to see what else you can do.

0 commit comments

Comments
 (0)