Skip to main content
New to Corsair? See API access, authentication, and error handling.

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
Input The token appears only in this response and never on a later read, so store it now. Output

delete

apiKeys.delete Revoke an API key permanently; anything still using it stops authenticating Risk: destructive · Irreversible
Input Output

list

apiKeys.list List the account’s API keys without their tokens, with owner and creation time Risk: read
Input Output

Domains

create

domains.create Reserve a hostname and return the CNAME target to point DNS at; certificate issuance starts once it resolves Risk: write
Input Reserving returns a cname_target to point DNS at; certificate issuance starts once the record resolves.
Output

delete

domains.delete Release a reserved domain, which stops it resolving through ngrok; another account can then claim it Risk: destructive · Irreversible
Input Output

get

domains.get Read one reserved domain, including its certificate provisioning status Risk: read
Input Output

list

domains.list List reserved domains with their CNAME target and certificate state Risk: read
Input Output

update

domains.update Change a reserved domain’s description, certificate, management policy or allowed IPs Risk: write
Input
Output

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
Input The endpoint starts forwarding on its public URL as soon as it exists. Output

delete

endpoints.delete Delete a cloud endpoint; its public URL stops resolving and ngrok has no restore call Risk: destructive · Irreversible
Input Output

get

endpoints.get Read one cloud endpoint by id Risk: read
Input Output

list

endpoints.list List cloud endpoints with their public URL, upstream and traffic policy, newest first Risk: read
Input Output

update

endpoints.update Change an endpoint’s description, metadata, traffic policy or bindings, leaving fields that are omitted alone Risk: write
Input Output

Events

create

events.create Subscribe to event types and deliver them to existing destination ids, which are created through a separate API Risk: write
Input Destination ids must already exist; destinations are created through a separate ngrok API.
Output

delete

events.delete Delete an event subscription, which stops those events being delivered Risk: destructive · Irreversible
Input Output

get

events.get Read one event subscription by id Risk: read
Input Output

list

events.list List event subscriptions with their sources and destinations Risk: read
Input Output

Tunnels

list

tunnels.list List the tunnels open agent sessions and their public URLs Risk: read
Input Output