Skip to content

Commit

Permalink
automated generation of docs from buildkite
Browse files Browse the repository at this point in the history
  • Loading branch information
the ngrok rock 🪨 committed Nov 30, 2024
1 parent 338de99 commit d6ee9a4
Show file tree
Hide file tree
Showing 390 changed files with 1,423 additions and 936 deletions.
29 changes: 26 additions & 3 deletions docs/agent/cli-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5644,6 +5644,7 @@ ngrok api kubernetes-operators create [flags]
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--binding.name` | the name by which endpoints can be bound to this Kubernetes Operator. starts with "k8s/" |
| `--deployment.cluster-name` | user-given name for the cluster the Kubernetes Operator is deployed to |
| `--deployment.name` | the deployment name |
| `--deployment.namespace` | the namespace this Kubernetes Operator is deployed to |
| `--deployment.version` | the version of this Kubernetes Operator |
Expand Down Expand Up @@ -5759,6 +5760,7 @@ ngrok api kubernetes-operators update <id> [flags]
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--binding.name` | the name by which endpoints can be bound to this Kubernetes Operator. starts with "k8s/" |
| `--deployment.name` | the deployment name |
| `--description` | human-readable description of this Kubernetes Operator. optional, max 255 bytes. |
| `--enabled-features` | features enabled for this Kubernetes Operator. a subset of \{"bindings", "ingress", and "gateway"\} |
| `--metadata` | arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes. |
Expand Down Expand Up @@ -7249,9 +7251,10 @@ ngrok api reserved-domains update <id> [flags]

### SubCommands

| Command | Description |
| -------------------------- | ----------- |
| [get](#ngrok-api-root-get) | |
| Command | Description |
| ---------------------------- | -------------------------------------------------- |
| [get](#ngrok-api-root-get) | |
| [self](#ngrok-api-root-self) | Get the details of the data used in this curren... |

### Flags

Expand Down Expand Up @@ -7281,6 +7284,26 @@ ngrok api root get [flags]
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |

## ngrok api root self

Get the details of the data used in this current request

### Usage

```sh
ngrok api root self [flags]
```

### Flags

| Flag | Description |
| -------------- | ------------------------------------------------------- |
| `--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' |
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |

## ngrok api ssh-certificate-authorities

An SSH Certificate Authority is a pair of an SSH Certificate and its private
Expand Down
6 changes: 3 additions & 3 deletions docs/api/examples/_abuse_reports_create_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

```json
{
"created_at": "2024-11-20T21:02:18Z",
"created_at": "2024-11-30T10:08:39Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2p88rEwkErTH4A3roB4e3FOnorB",
"id": "abrp_2pZ6bHcUorbrpLWY09Nm89ohNCb",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2p88rEwkErTH4A3roB4e3FOnorB",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2pZ6bHcUorbrpLWY09Nm89ohNCb",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_abuse_reports_get_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/abuse_reports/abrp_2p88rEwkErTH4A3roB4e3FOnorB
https://api.ngrok.com/abuse_reports/abrp_2pZ6bHcUorbrpLWY09Nm89ohNCb
```
6 changes: 3 additions & 3 deletions docs/api/examples/_abuse_reports_get_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

```json
{
"created_at": "2024-11-20T21:02:18Z",
"created_at": "2024-11-30T10:08:39Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2p88rEwkErTH4A3roB4e3FOnorB",
"id": "abrp_2pZ6bHcUorbrpLWY09Nm89ohNCb",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2p88rEwkErTH4A3roB4e3FOnorB",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2pZ6bHcUorbrpLWY09Nm89ohNCb",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_create_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-20T21:02:19Z",
"created_at": "2024-11-30T10:08:40Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2p88rJKsaW2ff2KotYDxKEfqe6N",
"id": "agin_2pZ6bJBMARvx95qaMS78aLTNyHx",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N"
"uri": "/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx"
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_delete_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N
https://api.ngrok.com/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx
```
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_get_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N
https://api.ngrok.com/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_get_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-20T21:02:19Z",
"created_at": "2024-11-30T10:08:40Z",
"description": "ACME Co. Device Ingress",
"domain": "connect.acme.com",
"id": "agin_2p88rJKsaW2ff2KotYDxKEfqe6N",
"id": "agin_2pZ6bJBMARvx95qaMS78aLTNyHx",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
Expand All @@ -18,6 +18,6 @@
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N"
"uri": "/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx"
}
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_list_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-20T21:02:19Z",
"created_at": "2024-11-30T10:08:40Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2p88rJKsaW2ff2KotYDxKEfqe6N",
"id": "agin_2pZ6bJBMARvx95qaMS78aLTNyHx",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N"
"uri": "/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx"
}
],
"next_page_uri": null,
Expand Down
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_update_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ curl \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \
https://api.ngrok.com/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N
https://api.ngrok.com/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_update_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-20T21:02:19Z",
"created_at": "2024-11-30T10:08:40Z",
"description": "ACME Co. Device Ingress",
"domain": "connect.acme.com",
"id": "agin_2p88rJKsaW2ff2KotYDxKEfqe6N",
"id": "agin_2pZ6bJBMARvx95qaMS78aLTNyHx",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
Expand All @@ -18,6 +18,6 @@
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2p88rJKsaW2ff2KotYDxKEfqe6N"
"uri": "/agent_ingresses/agin_2pZ6bJBMARvx95qaMS78aLTNyHx"
}
```
10 changes: 5 additions & 5 deletions docs/api/examples/_api_keys_create_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

```json
{
"created_at": "2024-11-20T21:01:56Z",
"created_at": "2024-11-30T10:08:15Z",
"description": "ad-hoc dev testing",
"id": "ak_2p88oRyYoQmY9RPcx08pqIzr1rh",
"id": "ak_2pZ6YGGD0FEkORwkV3Mejx82UDT",
"metadata": "{\"environment\":\"dev\"}",
"owner_id": "usr_2p88oSkme3DmEiKmEBxZDpSvnDf",
"token": "2p88oRyYoQmY9RPcx08pqIzr1rh_spyMGB5h1MyXdzuuDNbL",
"uri": "https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh"
"owner_id": "usr_2pZ6YFDDymVsoxyTMoJmi1j3iOo",
"token": "2pZ6YGGD0FEkORwkV3Mejx82UDT_3Lvv73C42q231mC6FnSWF",
"uri": "https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT"
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_api_keys_delete_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh
https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT
```
2 changes: 1 addition & 1 deletion docs/api/examples/_api_keys_get_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh
https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT
```
8 changes: 4 additions & 4 deletions docs/api/examples/_api_keys_get_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

```json
{
"created_at": "2024-11-20T21:01:56Z",
"created_at": "2024-11-30T10:08:15Z",
"description": "ad-hoc dev testing",
"id": "ak_2p88oRyYoQmY9RPcx08pqIzr1rh",
"id": "ak_2pZ6YGGD0FEkORwkV3Mejx82UDT",
"metadata": "{\"environment\":\"dev\", \"owner_id\": 123}",
"owner_id": "usr_2p88oSkme3DmEiKmEBxZDpSvnDf",
"owner_id": "usr_2pZ6YFDDymVsoxyTMoJmi1j3iOo",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh"
"uri": "https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT"
}
```
22 changes: 11 additions & 11 deletions docs/api/examples/_api_keys_list_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@
{
"keys": [
{
"created_at": "2024-11-20T21:01:56Z",
"description": "ad-hoc dev testing",
"id": "ak_2p88oRyYoQmY9RPcx08pqIzr1rh",
"metadata": "{\"environment\":\"dev\"}",
"owner_id": "usr_2p88oSkme3DmEiKmEBxZDpSvnDf",
"created_at": "2024-11-30T10:08:15Z",
"description": "api key for example generation",
"id": "ak_2pZ6YCbiheZYgEB6b7PRNfScm5m",
"owner_id": "usr_2pZ6YFDDymVsoxyTMoJmi1j3iOo",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh"
"uri": "https://api.ngrok.com/api_keys/ak_2pZ6YCbiheZYgEB6b7PRNfScm5m"
},
{
"created_at": "2024-11-20T21:01:56Z",
"description": "api key for example generation",
"id": "ak_2p88oU9sId3wqGWpS3Tjg8pnvWK",
"owner_id": "usr_2p88oSkme3DmEiKmEBxZDpSvnDf",
"created_at": "2024-11-30T10:08:15Z",
"description": "ad-hoc dev testing",
"id": "ak_2pZ6YGGD0FEkORwkV3Mejx82UDT",
"metadata": "{\"environment\":\"dev\"}",
"owner_id": "usr_2pZ6YFDDymVsoxyTMoJmi1j3iOo",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2p88oU9sId3wqGWpS3Tjg8pnvWK"
"uri": "https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT"
}
],
"next_page_uri": null,
Expand Down
2 changes: 1 addition & 1 deletion docs/api/examples/_api_keys_update_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ curl \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"environment\":\"dev\", \"owner_id\": 123}"}' \
https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh
https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT
```
8 changes: 4 additions & 4 deletions docs/api/examples/_api_keys_update_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

```json
{
"created_at": "2024-11-20T21:01:56Z",
"created_at": "2024-11-30T10:08:15Z",
"description": "ad-hoc dev testing",
"id": "ak_2p88oRyYoQmY9RPcx08pqIzr1rh",
"id": "ak_2pZ6YGGD0FEkORwkV3Mejx82UDT",
"metadata": "{\"environment\":\"dev\", \"owner_id\": 123}",
"owner_id": "usr_2p88oSkme3DmEiKmEBxZDpSvnDf",
"owner_id": "usr_2pZ6YFDDymVsoxyTMoJmi1j3iOo",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2p88oRyYoQmY9RPcx08pqIzr1rh"
"uri": "https://api.ngrok.com/api_keys/ak_2pZ6YGGD0FEkORwkV3Mejx82UDT"
}
```
6 changes: 3 additions & 3 deletions docs/api/examples/_bot_users_create_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
{
"active": true,
"created_at": "2024-11-20T21:02:24Z",
"id": "bot_2p88s0LafYAiiLuvBFQK1V6RPsn",
"created_at": "2024-11-30T10:08:45Z",
"id": "bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS",
"name": "new bot user from API",
"uri": "https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn"
"uri": "https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS"
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_bot_users_delete_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn
https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS
```
2 changes: 1 addition & 1 deletion docs/api/examples/_bot_users_get_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn
https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS
```
6 changes: 3 additions & 3 deletions docs/api/examples/_bot_users_get_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
{
"active": true,
"created_at": "2024-11-20T21:02:24Z",
"id": "bot_2p88s0LafYAiiLuvBFQK1V6RPsn",
"created_at": "2024-11-30T10:08:45Z",
"id": "bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS",
"name": "new bot user from API",
"uri": "https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn"
"uri": "https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS"
}
```
8 changes: 4 additions & 4 deletions docs/api/examples/_bot_users_list_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
"bot_users": [
{
"active": false,
"created_at": "2024-11-20T21:02:24Z",
"id": "bot_2p88s0LafYAiiLuvBFQK1V6RPsn",
"created_at": "2024-11-30T10:08:45Z",
"id": "bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS",
"name": "inactive bot user from API",
"uri": "https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn"
"uri": "https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS"
}
],
"next_page_uri": "https://api.ngrok.com/bot_users?before_id=bot_2p88s0LafYAiiLuvBFQK1V6RPsn&limit=1",
"next_page_uri": "https://api.ngrok.com/bot_users?before_id=bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS&limit=1",
"uri": "https://api.ngrok.com/bot_users"
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_bot_users_update_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ curl \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"active":false,"name":"inactive bot user from API"}' \
https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn
https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS
```
6 changes: 3 additions & 3 deletions docs/api/examples/_bot_users_update_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
{
"active": false,
"created_at": "2024-11-20T21:02:24Z",
"id": "bot_2p88s0LafYAiiLuvBFQK1V6RPsn",
"created_at": "2024-11-30T10:08:45Z",
"id": "bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS",
"name": "inactive bot user from API",
"uri": "https://api.ngrok.com/bot_users/bot_2p88s0LafYAiiLuvBFQK1V6RPsn"
"uri": "https://api.ngrok.com/bot_users/bot_2pZ6c1mMlWybuWM5QMNvE7qHXAS"
}
```
Loading

0 comments on commit d6ee9a4

Please sign in to comment.