v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB

AbuseReports2

AgentIngresses5

APIKeys5

ApplicationSessions3

ApplicationUsers3

BotUsers5

CertificateAuthorities5

Credentials5

EdgeRouteBackendModule3

EdgeRouteCircuitBreakerModule3

EdgeRouteCompressionModule3

EdgeRouteIPRestrictionModule3

EdgeRouteOAuthModule3

EdgeRouteOIDCModule3

EdgeRouteRequestHeadersModule3

EdgeRouteResponseHeadersModule3

EdgeRouteSAMLModule3

EdgeRouteTrafficPolicyModule3

EdgeRouteUserAgentFilterModule3

EdgeRouteWebhookVerificationModule3

EdgeRouteWebsocketTCPConverterModule3

EdgesHTTPS5

EdgesHTTPSRoutes4

EdgesTCP5

EdgesTLS5

Endpoints5

EventDestinations5

EventSources5

EventSubscriptions5

FailoverBackends5

HTTPResponseBackends5

HTTPSEdgeMutualTLSModule3

HTTPSEdgeTLSTerminationModule3

IPPolicies5

IPPolicyRules5

IPRestrictions5

ReservedAddrs5

ReservedDomains7

Secrets5

ServiceUsers5

SSHCertificateAuthorities5

SSHCredentials5

SSHHostCertificates5

SSHUserCertificates5

StaticBackends5

TCPEdgeBackendModule3

TCPEdgeIPRestrictionModule3

TCPEdgeTrafficPolicyModule3

TLSCertificates5

TLSEdgeBackendModule3

TLSEdgeIPRestrictionModule3

TLSEdgeMutualTLSModule3

TLSEdgeTLSTerminationModule3

TLSEdgeTrafficPolicyModule3

TunnelGroupBackends5

Tunnels2

TunnelSessions5

Vaults6

WeightedBackends5

Vaults

Get

Get a Vault by ID

get/vaults/{id}

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get a Vault by ID

idstring

identifier for Vault

uristring

URI of this Vault API resource

created_atstring

Timestamp when the Vault was created (RFC 3339 format)

updated_atstring

Timestamp when the Vault was last updated (RFC 3339 format)

namestring

Name of vault

descriptionstring

description of Vault

metadatastring

Arbitrary user-defined metadata for this Vault

created_bystring

Reference to who created this Vault

last_updated_bystring

Reference to who created this Vault