Skip to content

Docs: Auto-generated documentation update #2121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sg-writer merged 1 commit into from
May 7, 2026
Merged

Docs: Auto-generated documentation update #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions agent/cli-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1650,8 +1650,8 @@ ngrok api bot-users create [flags]

| Flag | Description |
| ----------------- | --------------------------------------- |
| `--active` | whether or not the bot is active |
| `--name` | human-readable name used to identify the bot |
| `--active` | whether or not the service user is active |
| `--name` | human-readable name used to identify the service user |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
Expand Down Expand Up @@ -1738,8 +1738,8 @@ ngrok api bot-users update <id> [flags]

| Flag | Description |
| ----------------- | --------------------------------------- |
| `--active` | whether or not the bot is active |
| `--name` | human-readable name used to identify the bot |
| `--active` | whether or not the service user is active |
| `--name` | human-readable name used to identify the service user |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
Expand Down
2 changes: 1 addition & 1 deletion errors/err_ngrok_314.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Upgrade to a paid plan at: https://dashboard.ngrok.com/billing/choose-a-plan

### Possible Solutions

- Upgrade your account to a Pay-as-you-go plan from your [account dashboard](https://dashboard.ngrok.com/billing/plan) in order to reserve a custom hostname.
- Upgrade your account to a Pro or Pay-as-you-go plan from your [account dashboard](https://dashboard.ngrok.com/billing/plan) in order to reserve a custom hostname.

<Tip>
If you don't need a fully-custom hostname, you can reserve a custom ngrok domain (like `example.ngrok.app`) on our paid plans.
Expand Down
2 changes: 1 addition & 1 deletion errors/err_ngrok_702.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Too many connections! The tunnel session `SESSION` has violated the rate-limit p

### Possible Solutions

- Upgrade your account to a Pay-as-you-go plan from your [account dashboard](https://dashboard.ngrok.com/billing/plan) in order to reserve a custom hostname.
- Upgrade your account to a Pro or Pay-as-you-go plan from your [account dashboard](https://dashboard.ngrok.com/billing/plan) in order to reserve a custom hostname.


## Further help
Expand Down
5 changes: 3 additions & 2 deletions errors/err_ngrok_737.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ title: Error 737
keywords: ["ERR_NGROK_737", "error 737"]
---

## Message
This ngrok account has reached its traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo

## ERR_NGROK_737
This ngrok account has reached its Enterprise traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo



Expand Down
5 changes: 3 additions & 2 deletions errors/err_ngrok_740.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ title: Error 740
keywords: ["ERR_NGROK_740", "error 740"]
---

## Message
This ngrok account has reached its traffic policy connection limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo

## ERR_NGROK_740
This ngrok account has reached its Enterprise traffic policy connection limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo



Expand Down
4 changes: 2 additions & 2 deletions snippets/errors/_err_ngrok_list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,10 +284,10 @@
| [ERR_NGROK_734](/errors/err_ngrok_734) | You have exceeded your limit of `MAX` requests per `INTERVAL`. This limit will reset within 1 minute. If you expect to continually exceed these limits, please upgrade your plan at https://dashboard.ngrok.com/billing |
| [ERR_NGROK_735](/errors/err_ngrok_735) | This ngrok account has reached its Advanced traffic policy request limit for the month. Log into https://dashboard.ngrok.com/billing to view your options. |
| [ERR_NGROK_736](/errors/err_ngrok_736) | This ngrok account has reached its Basic traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_737](/errors/err_ngrok_737) | This ngrok account has reached its traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_737](/errors/err_ngrok_737) | This ngrok account has reached its Enterprise traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_738](/errors/err_ngrok_738) | This ngrok account has reached its Advanced traffic policy request limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_739](/errors/err_ngrok_739) | This ngrok account has reached its Basic traffic policy connection limit for the month. Upgrade to a pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_740](/errors/err_ngrok_740) | This ngrok account has reached its traffic policy connection limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_740](/errors/err_ngrok_740) | This ngrok account has reached its Enterprise traffic policy connection limit for the month. Upgrade to a Pay-as-you-go plan at https://dashboard.ngrok.com/billing/choose-a-plan?plan=paygo |
| [ERR_NGROK_741](/errors/err_ngrok_741) | Internal server error. |
| [ERR_NGROK_800](/errors/err_ngrok_800) | Unknown stream type: `TYPE`. |
| [ERR_NGROK_801](/errors/err_ngrok_801) | The request payload you specified is not valid. |
Expand Down
4 changes: 2 additions & 2 deletions snippets/obs/_bot-user-create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| Name | Type | Description |
|---|---|---|
| name | string | human-readable name used to identify the bot |
| active | boolean | whether or not the bot is active |
| name | string | human-readable name used to identify the service user |
| active | boolean | whether or not the service user is active |
4 changes: 2 additions & 2 deletions snippets/obs/_bot-user-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
| Name | Type | Description |
|---|---|---|
| id | string | |
| name | string | human-readable name used to identify the bot |
| active | boolean | whether or not the bot is active |
| name | string | human-readable name used to identify the service user |
| active | boolean | whether or not the service user is active |
2 changes: 1 addition & 1 deletion snippets/obs/_bot-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
| id | string | unique API key resource identifier |
| uri | string | URI to the API resource of this service user |
| name | string | human-readable name used to identify the service user |
| active | boolean | whether or not the bot is active |
| active | boolean | whether or not the service user is active |
| created_at | string | timestamp when the api key was created, RFC 3339 format |