View as Markdown
ngrok icon

ngrok ACTION

Update HTTPS Edge

Updates an HTTPS Edge. See the documentation.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ngrok account once, then configure and run Update HTTPS Edge from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ngrok-update-https-edge",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ngrok: { authProvisionId: "apn_xxxxxxx" },
    edgeId: "Edge ID",
    description: "Description",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update HTTPS Edge inputs
Property Type Description
edgeId Edge ID string
The ID of the edge to update.
Required Dynamic
description Description string
What this edge will be used for.
Required
hostports Host Ports string[]
Hostports served by this edge. Eg: example.com:443
Optional
metadata Metadata object
The metadata of the agent ingress. Arbitrary user-defined machine-readable data.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ngrok-update-https-edge
Version
0.0.2
App
ngrok
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes