Api Keys
create
apiKeys.create
Mint an API key; the token is returned once in this response and never again, so it must be stored now
Risk: write
delete
apiKeys.delete
Revoke an API key permanently; anything still using it stops authenticating
Risk: destructive · Irreversible
list
apiKeys.list
List the account’s API keys without their tokens, with owner and creation time
Risk: read
keys full type
keys full type
Domains
create
domains.create
Reserve a hostname and return the CNAME target to point DNS at; certificate issuance starts once it resolves
Risk: write
certificate_management_policy full type
certificate_management_policy full type
resolves_to full type
resolves_to full type
certificate full type
certificate full type
certificate_management_policy full type
certificate_management_policy full type
resolves_to full type
resolves_to full type
certificate_management_status full type
certificate_management_status full type
delete
domains.delete
Release a reserved domain, which stops it resolving through ngrok; another account can then claim it
Risk: destructive · Irreversible
get
domains.get
Read one reserved domain, including its certificate provisioning status
Risk: read
certificate full type
certificate full type
certificate_management_policy full type
certificate_management_policy full type
resolves_to full type
resolves_to full type
certificate_management_status full type
certificate_management_status full type
list
domains.list
List reserved domains with their CNAME target and certificate state
Risk: read
reserved_domains full type
reserved_domains full type
update
domains.update
Change a reserved domain’s description, certificate, management policy or allowed IPs
Risk: write
certificate_management_policy full type
certificate_management_policy full type
resolves_to full type
resolves_to full type
certificate full type
certificate full type
certificate_management_policy full type
certificate_management_policy full type
resolves_to full type
resolves_to full type
certificate_management_status full type
certificate_management_status full type
Endpoints
create
endpoints.create
Create a cloud endpoint at a URL you own (e.g. your ngrok dev domain); its required Traffic Policy decides what happens to requests, and it serves immediately
Risk: write
domain full type
domain full type
tcp_addr full type
tcp_addr full type
tunnel full type
tunnel full type
principal full type
principal full type
tunnel_session full type
tunnel_session full type
delete
endpoints.delete
Delete a cloud endpoint; its public URL stops resolving and ngrok has no restore call
Risk: destructive · Irreversible
get
endpoints.get
Read one cloud endpoint by id
Risk: read
domain full type
domain full type
tcp_addr full type
tcp_addr full type
tunnel full type
tunnel full type
principal full type
principal full type
tunnel_session full type
tunnel_session full type
list
endpoints.list
List cloud endpoints with their public URL, upstream and traffic policy, newest first
Risk: read
endpoints full type
endpoints full type
update
endpoints.update
Change an endpoint’s description, metadata, traffic policy or bindings, leaving fields that are omitted alone
Risk: write
domain full type
domain full type
tcp_addr full type
tcp_addr full type
tunnel full type
tunnel full type
principal full type
principal full type
tunnel_session full type
tunnel_session full type
Events
create
events.create
Subscribe to event types and deliver them to existing destination ids, which are created through a separate API
Risk: write
sources full type
sources full type
sources full type
sources full type
destinations full type
destinations full type
delete
events.delete
Delete an event subscription, which stops those events being delivered
Risk: destructive · Irreversible
get
events.get
Read one event subscription by id
Risk: read
sources full type
sources full type
destinations full type
destinations full type
list
events.list
List event subscriptions with their sources and destinations
Risk: read
event_subscriptions full type
event_subscriptions full type
Tunnels
list
tunnels.list
List the tunnels open agent sessions and their public URLs
Risk: read
tunnels full type
tunnels full type