> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ngrok

The ngrok connector lets your AI agent act in each user's ngrok account. Each user connects their own ngrok access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

**Authentication:** Bearer Token
**Categories:** Developer Tools
**Tools:** 59: 29 read, 19 write, 11 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=NGROK)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ngrok connection

   In **AgentKit > Connections**, create a ngrok connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'ngrok'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ngrok:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'ngrok_agent_ingresses_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "ngrok"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ngrok:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="ngrok_agent_ingresses_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ngrok credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'ngrok_agent_ingress_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'ngrok',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="ngrok_agent_ingress_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="ngrok",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `ngrok_agent_ingress_get`

Get Agent Ingress · Read-only

Get one agent ingress by ID. Returns the agent ingress with domain, ns_targets, region domains and certificate status. Use this when you know the ID. Use ngrok_agent_ingresses_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: agin_2nGsUw4HfJ1vXq3bZt9eL8CkYdR.

Example input: `{"id":"<id>"}`

### `ngrok_agent_ingresses_list`

List Agent Ingresses · Read-only

List agent ingresses in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of agent ingresses with next_page_uri; pass the last ID as before_id for the next page. Use this to browse agent ingresses. Use ngrok_agent_ingress_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, created_at, description, metadata, domain. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_api_key_get`

Get API Key · Read-only

Get one api key by ID. Returns the API key with description, metadata and owner (the token itself is not returned). Use this when you know the ID. Use ngrok_api_keys_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.

Example input: `{"id":"<id>"}`

### `ngrok_api_keys_list`

List API Keys · Read-only

List API keys in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of API keys with next_page_uri; pass the last ID as before_id for the next page. Use this to browse API keys. Use ngrok_api_key_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, owner_id, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_credential_get`

Get Credential · Read-only

Get one credential by ID. Returns the credential with description, metadata, acl and owner (the token itself is not returned). Use this when you know the ID. Use ngrok_credentials_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.

Example input: `{"id":"<id>"}`

### `ngrok_credentials_list`

List Credentials · Read-only

List credentials in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of credentials with next_page_uri; pass the last ID as before_id for the next page. Use this to browse credentials. Use ngrok_credential_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, owner_id, acl, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_endpoint_get`

Get Endpoint · Read-only

Get one endpoint by ID. Returns the endpoint with url, type (agent or cloud), proto, traffic_policy, bindings, tunnel or edge reference and timestamps. Use this when you know the ID. Use ngrok_endpoints_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.

Example input: `{"id":"<id>"}`

### `ngrok_endpoints_list`

List Endpoints · Read-only

List endpoints in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of endpoints with next_page_uri; pass the last ID as before_id for the next page. Use this to browse endpoints. Use ngrok_endpoint_get for one by ID. Agent endpoints started by the ngrok agent appear here too.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, url, type, pooling_enabled, region, scheme, description, metadata, name, created_at, principal.id, bindings. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_event_subscription_get`

Get Event Subscription · Read-only

Get one event subscription by ID. Returns the subscription with its event sources and destinations. Use this when you know the ID. Use ngrok_event_subscriptions_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: esb_2nGsWy7MbQ0rTn5cXv2fH6JpAuL.

Example input: `{"id":"<id>"}`

### `ngrok_event_subscriptions_list`

List Event Subscriptions · Read-only

List event subscriptions in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of event subscriptions with next_page_uri; pass the last ID as before_id for the next page. Use this to browse event subscriptions. Use ngrok_event_subscription_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_ip_policies_list`

List IP Policies · Read-only

List IP policies in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of IP policies with next_page_uri; pass the last ID as before_id for the next page. Use this to browse IP policies. Use ngrok_ip_policy_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_ip_policy_get`

Get IP Policy · Read-only

Get one ip policy by ID. Returns the IP policy with description and metadata. Use this when you know the ID. Use ngrok_ip_policies_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_rule_get`

Get IP Policy Rule · Read-only

Get one ip policy rule by ID. Returns the rule with cidr, action (allow or deny) and its IP policy. Use this when you know the ID. Use ngrok_ip_policy_rules_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_rules_list`

List IP Policy Rules · Read-only

List IP policy rules in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of IP policy rules with next_page_uri; pass the last ID as before_id for the next page. Use this to browse IP policy rules. Use ngrok_ip_policy_rule_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, created_at, description, metadata, cidr, ip_policy_id, action. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_reserved_addr_get`

Get Reserved Addr · Read-only

Get one reserved addr by ID. Returns the address with addr, region, description and metadata. Use this when you know the ID. Use ngrok_reserved_addrs_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.

Example input: `{"id":"<id>"}`

### `ngrok_reserved_addrs_list`

List Reserved Addrs · Read-only

List reserved addrs in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of reserved addrs with next_page_uri; pass the last ID as before_id for the next page. Use this to browse reserved addrs. Use ngrok_reserved_addr_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, addr, region, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_reserved_domain_get`

Get Reserved Domain · Read-only

Get one reserved domain by ID. Returns the domain with its cname_target, certificate, certificate management status and timestamps. Use this when you know the ID. Use ngrok_reserved_domains_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.

Example input: `{"id":"<id>"}`

### `ngrok_reserved_domains_list`

List Reserved Domains · Read-only

List reserved domains in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of reserved domains with next_page_uri; pass the last ID as before_id for the next page. Use this to browse reserved domains. Use ngrok_reserved_domain_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, domain, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_service_users_list`

List Service Users · Read-only

List service users in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of service users with next_page_uri; pass the last ID as before_id for the next page. Use this to browse service users. Use ngrok_service_user_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, name, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_tls_certificate_get`

Get TLS Certificate · Read-only

Get one tls certificate by ID. Returns the certificate with subject names, issuer, validity dates and key type. Use this when you know the ID. Use ngrok_tls_certificates_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.

Example input: `{"id":"<id>"}`

### `ngrok_tls_certificates_list`

List TLS Certificates · Read-only

List TLS certificates in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of TLS certificates with next_page_uri; pass the last ID as before_id for the next page. Use this to browse TLS certificates. Use ngrok_tls_certificate_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, description, metadata, subject_common_name, not_before, not_after, serial_number, created_at. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_tunnel_get`

Get Tunnel · Read-only

Get one online tunnel by ID. Returns the tunnel with public_url, proto, region, forwards_to and its tunnel session. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: tn_2nGrd6WYdnbo8T7JAt4UzLsX1QB.

Example input: `{"id":"<id>"}`

### `ngrok_tunnel_session_get`

Get Tunnel Session · Read-only

Get one online agent session by ID. Returns the session with agent version, IP, OS, region and credential. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.

Example input: `{"id":"<id>"}`

### `ngrok_tunnel_sessions_list`

List Tunnel Sessions · Read-only

List online ngrok agent sessions. Returns sessions with id, agent_version, ip, os, region, credential and started_at. Use this to see which agents are connected. Use ngrok_tunnels_list for what they expose.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, metadata, agent_version, ip, os, region, started_at, credential. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_tunnels_list`

List Tunnels · Read-only

List the tunnels currently online in the account (one per agent endpoint or tunnel). Returns tunnels with id, public_url, proto, region, tunnel_session, forwards_to and started_at. Use this to see what agents are exposing now. Use ngrok_tunnel_sessions_list for the agent sessions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): before id. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `limit` (`string`, optional): limit. Example: 25.

Example input: `{}`

### `ngrok_vault_get`

Get Vault · Read-only

Get one vault by ID. Returns the vault with name, description and metadata. Use this when you know the ID. Use ngrok_vaults_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.

Example input: `{"id":"<id>"}`

### `ngrok_vault_secret_get`

Get Vault Secret · Read-only

Get one secret's metadata by ID. Returns the secret's name, vault, description and metadata (not its value). Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.

Example input: `{"id":"<id>"}`

### `ngrok_vault_secrets_list`

List Vault Secrets · Read-only

List secrets across all vaults (names and metadata only, never values). filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of secrets with next_page_uri; pass the last ID as before_id for the next page. Use this to browse secrets. Use ngrok_vault_secret_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_vaults_list`

List Vaults · Read-only

List vaults in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of vaults with next_page_uri; pass the last ID as before_id for the next page. Use this to browse vaults. Use ngrok_vault_get for one by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `before_id` (`string`, optional): Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `filter` (`string`, optional): A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
- `limit` (`string`, optional): Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.

Example input: `{}`

### `ngrok_api_key_create`

Create API Key · Write

Create an API key; the token is returned only in this response. Returns the created api key. Use ngrok_api_key_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): human-readable description of what uses the API key to authenticate. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined data of this API key. optional, max 4096 bytes. Example: {"owner":"platform-team"}
- `owner_id` (`string`, optional): If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot. Example: usr_2nGsdF3RdV7wXr9gBz8jO3PtDyQ.

Example input: `{}`

### `ngrok_api_key_update`

Update API Key · Write

Update the editable fields of one api key; fields you leave out are unchanged. Returns the updated api key. Use this to edit. Use ngrok_api_key_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the api key. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.
- `description` (`string`, optional): human-readable description of what uses the API key to authenticate. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined data of this API key. optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"id":"<id>"}`

### `ngrok_credential_create`

Create Credential · Write

Create a tunnel credential (authtoken) for the ngrok agent, optionally limited by ACL rules such as bind:<domain>; the token is returned only in this response. Returns the created credential. Use ngrok_credential_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `acl` (`array`, optional): optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions. Example: ["bind:sk-test-api.ngrok.app"]
- `description` (`string`, optional): human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
- `owner_id` (`string`, optional): If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID. Example: usr_2nGsdF3RdV7wXr9gBz8jO3PtDyQ.

Example input: `{}`

### `ngrok_credential_update`

Update Credential · Write

Update the editable fields of one credential; fields you leave out are unchanged. Returns the updated credential. Use this to edit. Use ngrok_credential_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the credential. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.
- `acl` (`array`, optional): optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions. Example: ["bind:sk-test-api.ngrok.app"]
- `description` (`string`, optional): human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"id":"<id>"}`

### `ngrok_endpoint_create`

Create Endpoint · Write

Create a cloud endpoint: a public or internal URL whose traffic is handled entirely by a Traffic Policy (YAML or JSON). Returns the created endpoint. Use ngrok_endpoint_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `traffic_policy` (`string`, required): The Traffic Policy attached to this endpoint. Example: {"on_http_request":[{"actions":[{"type":"forward-internal","config":{"url":"https://api.internal"}}]}]}
- `type` (`string`, required): Type of endpoint. Only 'cloud' is currently supported (represents a Cloud Endpoint). Defaults to 'cloud' if not specified. Example: cloud.
- `url` (`string`, required): the url of the endpoint. Example: https://sk-test-api.ngrok.app.
- `bindings` (`array`, optional): the bindings associated with this endpoint. Example: ["public"]
- `description` (`string`, optional): user-supplied description of the associated tunnel. Example: sk-test staging API.
- `metadata` (`string`, optional): user-supplied metadata of the associated tunnel or edge object. Example: {"owner":"platform-team"}
- `pooling_enabled` (`boolean`, optional): n/a. Example: true.

Example input: `{"traffic_policy":"<traffic_policy>","type":"<type>","url":"<url>"}`

### `ngrok_endpoint_update`

Update Endpoint · Write

Update the editable fields of one endpoint; fields you leave out are unchanged. Returns the updated endpoint. Use this to edit. Use ngrok_endpoint_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the endpoint. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
- `bindings` (`array`, optional): the bindings associated with this endpoint. Example: ["public"]
- `description` (`string`, optional): user-supplied description of the associated tunnel. Example: sk-test staging API.
- `metadata` (`string`, optional): user-supplied metadata of the associated tunnel or edge object. Example: {"owner":"platform-team"}
- `pooling_enabled` (`boolean`, optional): n/a. Example: true.
- `traffic_policy` (`string`, optional): The Traffic Policy attached to this endpoint. Example: {"on_http_request":[{"actions":[{"type":"forward-internal","config":{"url":"https://api.internal"}}]}]}
- `url` (`string`, optional): the url of the endpoint. Example: https://sk-test-api.ngrok.app.

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_create`

Create IP Policy · Write

Create an IP policy: a named set of allow and deny CIDR rules used by IP restrictions and traffic policies. Returns the created ip policy. Use ngrok_ip_policy_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): human-readable description of the source IPs of this IP policy. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{}`

### `ngrok_ip_policy_rule_create`

Create IP Policy Rule · Write

Create an IP policy rule that allows or denies one CIDR in an IP policy. Returns the created ip policy rule. Use ngrok_ip_policy_rule_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `action` (`string`, required): the action to apply to the policy rule, either allow or deny. Example: allow.
- `cidr` (`string`, required): an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported. Example: 203.0.113.0/24.
- `ip_policy_id` (`string`, required): ID of the IP policy this IP policy rule will be attached to. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
- `description` (`string`, optional): human-readable description of the source IPs of this IP rule. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"action":"<action>","cidr":"<cidr>","ip_policy_id":"<ip_policy_id>"}`

### `ngrok_ip_policy_rule_update`

Update IP Policy Rule · Write

Update the editable fields of one ip policy rule; fields you leave out are unchanged. Returns the updated ip policy rule. Use this to edit. Use ngrok_ip_policy_rule_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the ip policy rule. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.
- `cidr` (`string`, optional): an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported. Example: 203.0.113.0/24.
- `description` (`string`, optional): human-readable description of the source IPs of this IP rule. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_update`

Update IP Policy · Write

Update the editable fields of one ip policy; fields you leave out are unchanged. Returns the updated ip policy. Use this to edit. Use ngrok_ip_policy_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the ip policie. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
- `description` (`string`, optional): human-readable description of the source IPs of this IP policy. optional, max 255 bytes. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"id":"<id>"}`

### `ngrok_reserved_addr_create`

Create Reserved Addr · Write

Create a reserved TCP address (host:port) in a region, for TCP endpoints. Returns the created reserved addr. Use ngrok_reserved_addr_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): human-readable description of what this reserved address will be used for. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
- `region` (`string`, optional): reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa). Example: us.

Example input: `{}`

### `ngrok_reserved_addr_update`

Update Reserved Addr · Write

Update the editable fields of one reserved addr; fields you leave out are unchanged. Returns the updated reserved addr. Use this to edit. Use ngrok_reserved_addr_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the reserved addr. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.
- `description` (`string`, optional): human-readable description of what this reserved address will be used for. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. Example: {"owner":"platform-team"}

Example input: `{"id":"<id>"}`

### `ngrok_reserved_domain_create`

Create Reserved Domain · Write

Create a reserved domain: an ngrok subdomain or your own domain (CNAME it to the returned target) with optional certificate settings. Returns the created reserved domain. Use ngrok_reserved_domain_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `certificate_id` (`string`, optional): ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
- `certificate_management_policy` (`object`, optional): configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id. Example: {"authority":"letsencrypt","private_key_type":"ecdsa"}
- `description` (`string`, optional): human-readable description of what this reserved domain will be used for. Example: sk-test staging API.
- `domain` (`string`, optional): hostname of the reserved domain. Example: sk-test-api.example.com.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
- `region` (`string`, optional): deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa). Example: us.
- `resolves_to` (`array`, optional): Region and IP resolution targets configured for the Domain. Example: [{"value":"global"}]

Example input: `{}`

### `ngrok_reserved_domain_update`

Update Reserved Domain · Write

Update the editable fields of one reserved domain; fields you leave out are unchanged. Returns the updated reserved domain. Use this to edit. Use ngrok_reserved_domain_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the reserved domain. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.
- `certificate_id` (`string`, optional): ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
- `certificate_management_policy` (`object`, optional): configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id. Example: {"authority":"letsencrypt","private_key_type":"ecdsa"}
- `description` (`string`, optional): human-readable description of what this reserved domain will be used for. Example: sk-test staging API.
- `metadata` (`string`, optional): arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
- `resolves_to` (`array`, optional): Region and IP resolution targets configured for the Domain. Example: [{"value":"global"}]

Example input: `{"id":"<id>"}`

### `ngrok_tunnel_session_restart`

Restart Tunnel Session · Write

Ask an agent to restart its process (agent 2.x and later). Returns an empty response once the request is sent. Use this to restart a remote agent. Use ngrok_tunnel_session_stop to shut it down.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the tunnel session. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.

Example input: `{"id":"<id>"}`

### `ngrok_tunnel_session_stop`

Stop Tunnel Session · Write

Ask an agent to stop its process and disconnect. Returns an empty response once the request is sent. Use this to take an agent offline. Use ngrok_tunnel_session_restart to restart it instead.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the tunnel session. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.

Example input: `{"id":"<id>"}`

### `ngrok_vault_create`

Create Vault · Write

Create a secrets vault that holds secrets referenced from traffic policies. Returns the created vault. Use ngrok_vault_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): description of Vault. Example: sk-test staging API.
- `metadata` (`string`, optional): Arbitrary user-defined metadata for this Vault. Example: {"owner":"platform-team"}
- `name` (`string`, optional): Name of vault. Example: sk-test-secrets.

Example input: `{}`

### `ngrok_vault_secret_create`

Create Vault Secret · Write

Create a secret in a vault, identified by vault_id or vault_name. Returns the created secret without its value. Use ngrok_vault_secret_update to rotate the value.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): description of Secret. Example: sk-test staging API.
- `metadata` (`string`, optional): Arbitrary user-defined metadata for this Secret. Example: {"owner":"platform-team"}
- `name` (`string`, optional): Name of secret. Example: sk-test-secrets.
- `value` (`string`, optional): Value of secret. Example: s3cr3t-value.
- `vault_id` (`string`, optional): unique identifier of the referenced vault. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.
- `vault_name` (`string`, optional): name of the referenced vault. Example: sk-test-secrets.

Example input: `{}`

### `ngrok_vault_secret_update`

Update Vault Secret · Write

Update a secret's name, value, description or metadata. Returns the updated secret without its value. Use this to rotate a secret.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the vault secret. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.
- `description` (`string`, optional): description of Secret. Example: sk-test staging API.
- `metadata` (`string`, optional): Arbitrary user-defined metadata for this Secret. Example: {"owner":"platform-team"}
- `name` (`string`, optional): Name of secret. Example: sk-test-secrets.
- `value` (`string`, optional): Value of secret. Example: s3cr3t-value.

Example input: `{"id":"<id>"}`

### `ngrok_api_key_delete`

Delete API Key · Destructive

Permanently delete one api key by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.

Example input: `{"id":"<id>"}`

### `ngrok_credential_delete`

Delete Credential · Destructive

Permanently delete one credential by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.

Example input: `{"id":"<id>"}`

### `ngrok_endpoint_delete`

Delete Endpoint · Destructive

Permanently delete one endpoint by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.

Example input: `{"id":"<id>"}`

### `ngrok_event_subscription_delete`

Delete Event Subscription · Destructive

Permanently delete one event subscription by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: esb_2nGsWy7MbQ0rTn5cXv2fH6JpAuL.

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_delete`

Delete IP Policy · Destructive

Permanently delete one ip policy by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.

Example input: `{"id":"<id>"}`

### `ngrok_ip_policy_rule_delete`

Delete IP Policy Rule · Destructive

Permanently delete one ip policy rule by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.

Example input: `{"id":"<id>"}`

### `ngrok_reserved_addr_delete`

Delete Reserved Addr · Destructive

Permanently delete one reserved addr by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.

Example input: `{"id":"<id>"}`

### `ngrok_reserved_domain_delete`

Delete Reserved Domain · Destructive

Permanently delete one reserved domain by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.

Example input: `{"id":"<id>"}`

### `ngrok_tls_certificate_delete`

Delete TLS Certificate · Destructive

Permanently delete one tls certificate by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.

Example input: `{"id":"<id>"}`

### `ngrok_vault_delete`

Delete Vault · Destructive

Permanently delete one vault by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.

Example input: `{"id":"<id>"}`

### `ngrok_vault_secret_delete`

Delete Vault Secret · Destructive

Permanently delete a secret. Returns an empty response on success. Use this to remove a secret; traffic policies that reference it will fail.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): a resource identifier. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.

Example input: `{"id":"<id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
