ngrok

Tunnels and endpoints: see what is online, agent sessions, credentials and reserved domains (read-only).

6 actions API key 6 read0 write Calls api.ngrok.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "ngrok" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Get reserved domainreadngrok.get_reserved_domainGet one reserved domain by id: domain, description, certificate and CNAME target.

Input	Type		Description
`id`	string	Required	Reserved domain id, e.g. rd_2abc

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.get_reserved_domain",
  input: {
    "id": "<id>"
  },
});

List agent sessionsreadngrok.list_agentsList ngrok agent sessions currently connected to the account: agent version, OS, IP and region.

Input	Type		Description
`limit`	integer	Optional	Page size, max 100
`before_id`	string	Optional	Resource id from the previous page's last item to get older items

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.list_agents",
  input: {},
});

List authtoken credentialsreadngrok.list_credentialsList the tunnel authtoken credentials: id, description and ACL. The secret token itself is only shown at creation.

Input	Type		Description
`limit`	integer	Optional	Page size, max 100
`before_id`	string	Optional	Resource id from the previous page's last item to get older items

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.list_credentials",
  input: {},
});

List endpointsreadngrok.list_endpointsList the endpoints on the account: id, public URL, type (cloud or agent), protocol and description.

Input	Type		Description
`limit`	integer	Optional	Page size, max 100
`before_id`	string	Optional	Resource id from the previous page's last item to get older items

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.list_endpoints",
  input: {},
});

List reserved domainsreadngrok.list_reserved_domainsList the reserved domains on the account: id, domain name, description and CNAME target.

Input	Type		Description
`limit`	integer	Optional	Page size, max 100
`before_id`	string	Optional	Resource id from the previous page's last item to get older items

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.list_reserved_domains",
  input: {},
});

List online tunnelsreadngrok.list_tunnelsList the tunnels currently online on the account: id, public URL, protocol and what they forward to.

Input	Type		Description
`limit`	integer	Optional	Page size, max 100
`before_id`	string	Optional	Resource id from the previous page's last item to get older items

TypeScript

await setu.execute({
  userId: "user_1",
  action: "ngrok.list_tunnels",
  input: {},
});