> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/ngrok.md).

# ngrok

Manage ngrok endpoints, tunnel sessions, reserved domains, API keys, and IP restrictions.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| ngrok     | API Key        |

#### ngrok

Connect with an ngrok API key to manage endpoints, sessions, domains, API keys, and IP restrictions.

**Set up in ngrok**

1. Prepare the ngrok account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API key in the ngrok dashboard. Use the API key secret, not an agent authtoken or API key id.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **ngrok**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                          |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Create an API key in the ngrok dashboard. Use the API key secret, not an agent authtoken or API key id. [Provider instructions](https://dashboard.ngrok.com/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **ngrok** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Reserved Domain

Reserve a hostname for ngrok endpoints.

**Inputs**

| Field       | Type     | Required | Description                          |
| ----------- | -------- | -------- | ------------------------------------ |
| Domain      | string   | Yes      | The hostname to reserve.             |
| Description | string   | No       | Why this domain is being reserved.   |
| Metadata    | textarea | No       | Machine-readable ownership metadata. |

**Outputs**

| Field                       | Type   | Description                                                  |
| --------------------------- | ------ | ------------------------------------------------------------ |
| Domain ID                   | string | The reserved-domain resource ID.                             |
| Domain                      | string | The reserved hostname.                                       |
| CNAME Target                | string | DNS CNAME target for a custom hostname, if required.         |
| ACME Challenge CNAME Target | string | DNS target for wildcard certificate validation, if required. |

#### List Active Tunnel Endpoints

List the account's currently active ngrok endpoints as typed endpoint objects.

**Inputs**

| Field           | Type    | Required | Description                                                         |
| --------------- | ------- | -------- | ------------------------------------------------------------------- |
| Maximum Results | integer | No       | Maximum endpoints to return. Minimum: 1. Maximum: 100. Default: 25. |
| Before ID       | string  | No       | Continue from an earlier result.                                    |
| Filter          | string  | No       | Optional ngrok CEL filter.                                          |

**Outputs**

| Field          | Type          | Description                              |
| -------------- | ------------- | ---------------------------------------- |
| Endpoints      | object\_array | Currently active ngrok endpoint objects. |
| Count          | integer       | Number of endpoints returned.            |
| Next Before ID | string        | Cursor for the next page.                |

#### Create API Key

Create an ngrok API key for a user or service user.

**Inputs**

| Field       | Type     | Required | Description                                              |
| ----------- | -------- | -------- | -------------------------------------------------------- |
| Description | string   | Yes      | What will use this API key.                              |
| Metadata    | textarea | No       | Machine-readable ownership metadata.                     |
| Owner ID    | string   | No       | Assign the key to a specific ngrok user or service user. |

**Outputs**

| Field         | Type   | Description                  |
| ------------- | ------ | ---------------------------- |
| API Key ID    | string | The new API-key resource ID. |
| API Key Token | secret | The one-time API key secret. |

#### Create IP Restriction Policy

Attach one or more IP policies to an ngrok account surface.

**Inputs**

| Field               | Type                      | Required | Description                                                                                                                                         |
| ------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Restriction Type    | select (string)           | Yes      | The ngrok surface to restrict. Available values: Dashboard, API, Agent, Endpoints. Default: endpoints.                                              |
| IP Policies         | multiple\_select (string) | Yes      | The existing IP policies to attach, selected as multiple values or entered as comma-separated exact IDs. Options load from the selected connection. |
| Description         | string                    | Yes      | A unique purpose or ownership tag.                                                                                                                  |
| Metadata            | textarea                  | No       | Machine-readable ownership metadata.                                                                                                                |
| Enforce Restriction | boolean                   | No       | Enforce matching policy rules instead of warning only. Default: false.                                                                              |

**Outputs**

| Field          | Type    | Description                                 |
| -------------- | ------- | ------------------------------------------- |
| IP Restriction | object  | The created ngrok IP restriction.           |
| Restriction ID | string  | The exact created resource ID.              |
| Enforced       | boolean | Whether ngrok is enforcing the restriction. |

#### List Tunnel Sessions

List online ngrok agent tunnel sessions as typed session objects.

**Inputs**

| Field           | Type    | Required | Description                                                               |
| --------------- | ------- | -------- | ------------------------------------------------------------------------- |
| Maximum Results | integer | No       | Maximum tunnel sessions to return. Minimum: 1. Maximum: 100. Default: 25. |
| Before ID       | string  | No       | Continue from an earlier result.                                          |
| Filter          | string  | No       | Optional ngrok CEL filter.                                                |

**Outputs**

| Field           | Type          | Description                          |
| --------------- | ------------- | ------------------------------------ |
| Tunnel Sessions | object\_array | Online ngrok tunnel-session objects. |
| Count           | integer       | Number of sessions returned.         |
| Next Before ID  | string        | Cursor for the next page.            |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/ngrok.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
