AI agents for ngrok

List endpoints

Lists the account's active endpoints: agent endpoints (a running ngrok agent serving a public URL) and cloud endpoints.

Get an endpoint

Reads one endpoint by ID: its public url, protocol, type, the local address it forwards to, its traffic_policy, bindings, the agent session serving it and its description and metadata.

List agent sessions

Lists the ngrok agents online now (tunnel sessions), as tunnel_sessions: each with its id, agent_version, os, source ip, region, metadata, started_at and the credential it used.

List reserved domains

Lists the account's reserved domains, as reserved_domains.

Create a cloud endpoint

Creates a cloud endpoint: a public URL (on a reserved domain or an ngrok-owned one) that lives in ngrok's network without an agent, whose traffic policy.

Delete a cloud endpointDeletes data

Deletes a cloud endpoint: its URL stops answering.

Stop an agent sessionDeletes data

Tells the ngrok agent that started a tunnel session to exit: its endpoints go offline until someone starts the agent again.

Restart an agent session

Tells an ngrok agent to restart itself (not supported on Windows); it reconnects with a new session ID and serves its endpoints again.

Reserve a domain

Reserves a domain for the account: an ngrok subdomain (like acme-api.ngrok.app) or your own hostname, which then needs the returned cname_target set as a CNAME in your DNS.