Skip to content

Commit b8728c6

Browse files
author
the ngrok rock 🪨
committed
automated generation of docs from buildkite
1 parent 8f8ceba commit b8728c6

File tree

482 files changed

+1494
-1475
lines changed

Some content is hidden

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

482 files changed

+1494
-1475
lines changed

‎docs/agent/cli-api.mdx‎

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,13 +1257,13 @@ ngrok api backends weighted update <id> [flags]
12571257

12581258
### SubCommands
12591259

1260-
| Command | Description |
1261-
| ------------------------------------- | ------------------------------------------ |
1262-
| [create](#ngrok-api-bot-users-create) | Create a new Service User |
1263-
| [delete](#ngrok-api-bot-users-delete) | Delete a service user by ID |
1264-
| [get](#ngrok-api-bot-users-get) | Get the details of a service user by ID. |
1265-
| [list](#ngrok-api-bot-users-list) | List all service users in this account. |
1266-
| [update](#ngrok-api-bot-users-update) | Update attributes of a service user by ID. |
1260+
| Command | Description |
1261+
| ------------------------------------- | -------------------------------------- |
1262+
| [create](#ngrok-api-bot-users-create) | Create a new bot user |
1263+
| [delete](#ngrok-api-bot-users-delete) | Delete a bot user by ID |
1264+
| [get](#ngrok-api-bot-users-get) | Get the details of a Bot User by ID. |
1265+
| [list](#ngrok-api-bot-users-list) | List all bot users in this account. |
1266+
| [update](#ngrok-api-bot-users-update) | Update attributes of a bot user by ID. |
12671267

12681268
### Flags
12691269

@@ -1339,7 +1339,7 @@ ngrok api bot-users get <id> [flags]
13391339

13401340
## ngrok api bot-users list
13411341

1342-
List all service users in this account.
1342+
List all bot users in this account.
13431343

13441344
### Usage
13451345

@@ -4698,7 +4698,9 @@ ngrok api endpoints list [flags]
46984698
| Flag | Description |
46994699
| -------------- | ------------------------------------------------------- |
47004700
| `--before-id` | |
4701+
| `--id` | |
47014702
| `--limit` | |
4703+
| `--url` | |
47024704
| `--api-key` | API key to use |
47034705
| `--config` | path to config files; they are merged if multiple |
47044706
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
@@ -8329,13 +8331,14 @@ Vaults is an api service for securely storing and managing sensitive data such a
83298331

83308332
### SubCommands
83318333

8332-
| Command | Description |
8333-
| ---------------------------------- | -------------------------------- |
8334-
| [create](#ngrok-api-vaults-create) | Create a new Vault |
8335-
| [delete](#ngrok-api-vaults-delete) | Delete a Vault |
8336-
| [get](#ngrok-api-vaults-get) | Get a Vault by ID |
8337-
| [list](#ngrok-api-vaults-list) | List all Vaults owned by account |
8338-
| [update](#ngrok-api-vaults-update) | Update an existing Vault by ID |
8334+
| Command | Description |
8335+
| -------------------------------------------------------------- | -------------------------------- |
8336+
| [create](#ngrok-api-vaults-create) | Create a new Vault |
8337+
| [delete](#ngrok-api-vaults-delete) | Delete a Vault |
8338+
| [get](#ngrok-api-vaults-get) | Get a Vault by ID |
8339+
| [get-secrets-by-vault](#ngrok-api-vaults-get-secrets-by-vault) | Get Secrets by Vault ID |
8340+
| [list](#ngrok-api-vaults-list) | List all Vaults owned by account |
8341+
| [update](#ngrok-api-vaults-update) | Update an existing Vault by ID |
83398342

83408343
### Flags
83418344

@@ -8410,6 +8413,28 @@ ngrok api vaults get <id> [flags]
84108413
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
84118414
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |
84128415

8416+
## ngrok api vaults get-secrets-by-vault
8417+
8418+
Get Secrets by Vault ID
8419+
8420+
### Usage
8421+
8422+
```sh
8423+
ngrok api vaults get-secrets-by-vault <id> [flags]
8424+
```
8425+
8426+
### Flags
8427+
8428+
| Flag | Description |
8429+
| -------------- | ------------------------------------------------------- |
8430+
| `--before-id` | |
8431+
| `--limit` | |
8432+
| `--api-key` | API key to use |
8433+
| `--config` | path to config files; they are merged if multiple |
8434+
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
8435+
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
8436+
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |
8437+
84138438
## ngrok api vaults list
84148439

84158440
List all Vaults owned by account

‎docs/api/resources/examples/_abuse_reports_create_response.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
```json
66
{
7-
"created_at": "2025-08-10T10:08:19Z",
7+
"created_at": "2025-09-03T10:07:48Z",
88
"hostnames": [
99
{
1010
"hostname": "legit-facebook-login.ngrok.io",
1111
"status": "PENDING"
1212
}
1313
],
14-
"id": "abrp_315inLKxHyXJVwFMIntoOYjgblR",
14+
"id": "abrp_32BVh6G1y4ybHnSZNWdmm4XlfXI",
1515
"metadata": "{\"incident_id\":1233122}",
1616
"status": "PENDING",
17-
"uri": "https://api.ngrok.com/abuse_reports/abrp_315inLKxHyXJVwFMIntoOYjgblR",
17+
"uri": "https://api.ngrok.com/abuse_reports/abrp_32BVh6G1y4ybHnSZNWdmm4XlfXI",
1818
"urls": [
1919
"http://legit-facebook-login.ngrok.io/login"
2020
]

‎docs/api/resources/examples/_abuse_reports_get_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ curl \
77
-X GET \
88
-H "Authorization: Bearer {API_KEY}" \
99
-H "Ngrok-Version: 2" \
10-
https://api.ngrok.com/abuse_reports/abrp_315inLKxHyXJVwFMIntoOYjgblR
10+
https://api.ngrok.com/abuse_reports/abrp_32BVh6G1y4ybHnSZNWdmm4XlfXI
1111
```

‎docs/api/resources/examples/_abuse_reports_get_response.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
```json
66
{
7-
"created_at": "2025-08-10T10:08:19Z",
7+
"created_at": "2025-09-03T10:07:48Z",
88
"hostnames": [
99
{
1010
"hostname": "legit-facebook-login.ngrok.io",
1111
"status": "PENDING"
1212
}
1313
],
14-
"id": "abrp_315inLKxHyXJVwFMIntoOYjgblR",
14+
"id": "abrp_32BVh6G1y4ybHnSZNWdmm4XlfXI",
1515
"metadata": "{\"incident_id\":1233122}",
1616
"status": "PENDING",
17-
"uri": "https://api.ngrok.com/abuse_reports/abrp_315inLKxHyXJVwFMIntoOYjgblR",
17+
"uri": "https://api.ngrok.com/abuse_reports/abrp_32BVh6G1y4ybHnSZNWdmm4XlfXI",
1818
"urls": [
1919
"http://legit-facebook-login.ngrok.io/login"
2020
]

‎docs/api/resources/examples/_agent_ingresses_create_response.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
{
77
"certificate_management_policy": null,
88
"certificate_management_status": null,
9-
"created_at": "2025-08-10T10:08:21Z",
9+
"created_at": "2025-09-03T10:07:49Z",
1010
"description": "acme devices",
1111
"domain": "connect.acme.com",
12-
"id": "agin_315inY1A779llVRcgAKSb5Ib7SN",
12+
"id": "agin_32BVhDojYDIcqOWut3E9LtdKyMh",
1313
"ns_targets": [
1414
"1.kube-dns.kube-system.svc.cluster.local.",
1515
"2.kube-dns.kube-system.svc.cluster.local.",
@@ -19,6 +19,6 @@
1919
"region_domains": [
2020
"tunnel.us.connect.acme.com"
2121
],
22-
"uri": "/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN"
22+
"uri": "/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh"
2323
}
2424
```

‎docs/api/resources/examples/_agent_ingresses_delete_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ curl \
77
-X DELETE \
88
-H "Authorization: Bearer {API_KEY}" \
99
-H "Ngrok-Version: 2" \
10-
https://api.ngrok.com/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN
10+
https://api.ngrok.com/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh
1111
```

‎docs/api/resources/examples/_agent_ingresses_get_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ curl \
77
-X GET \
88
-H "Authorization: Bearer {API_KEY}" \
99
-H "Ngrok-Version: 2" \
10-
https://api.ngrok.com/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN
10+
https://api.ngrok.com/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh
1111
```

‎docs/api/resources/examples/_agent_ingresses_get_response.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
{
77
"certificate_management_policy": null,
88
"certificate_management_status": null,
9-
"created_at": "2025-08-10T10:08:21Z",
9+
"created_at": "2025-09-03T10:07:49Z",
1010
"description": "ACME Co. Device Ingress",
1111
"domain": "connect.acme.com",
12-
"id": "agin_315inY1A779llVRcgAKSb5Ib7SN",
12+
"id": "agin_32BVhDojYDIcqOWut3E9LtdKyMh",
1313
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
1414
"ns_targets": [
1515
"1.kube-dns.kube-system.svc.cluster.local.",
@@ -20,6 +20,6 @@
2020
"region_domains": [
2121
"tunnel.us.connect.acme.com"
2222
],
23-
"uri": "/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN"
23+
"uri": "/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh"
2424
}
2525
```

‎docs/api/resources/examples/_agent_ingresses_list_response.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
{
99
"certificate_management_policy": null,
1010
"certificate_management_status": null,
11-
"created_at": "2025-08-10T10:08:21Z",
11+
"created_at": "2025-09-03T10:07:49Z",
1212
"description": "acme devices",
1313
"domain": "connect.acme.com",
14-
"id": "agin_315inY1A779llVRcgAKSb5Ib7SN",
14+
"id": "agin_32BVhDojYDIcqOWut3E9LtdKyMh",
1515
"ns_targets": [
1616
"1.kube-dns.kube-system.svc.cluster.local.",
1717
"2.kube-dns.kube-system.svc.cluster.local.",
@@ -21,7 +21,7 @@
2121
"region_domains": [
2222
"tunnel.us.connect.acme.com"
2323
],
24-
"uri": "/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN"
24+
"uri": "/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh"
2525
}
2626
],
2727
"next_page_uri": null,

‎docs/api/resources/examples/_agent_ingresses_update_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ curl \
99
-H "Content-Type: application/json" \
1010
-H "Ngrok-Version: 2" \
1111
-d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \
12-
https://api.ngrok.com/agent_ingresses/agin_315inY1A779llVRcgAKSb5Ib7SN
12+
https://api.ngrok.com/agent_ingresses/agin_32BVhDojYDIcqOWut3E9LtdKyMh
1313
```

0 commit comments

Comments
 (0)