Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReservedDomains

Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

Hierarchy

  • ReservedDomains

Index

Constructors

Methods

Constructors

constructor

  • Do not construct this object directly, use the reservedDomains property of an Ngrok client object instead.

    Parameters

    • httpClient: Wretcher

    Returns ReservedDomains

Methods

create

delete

  • delete(id: any): Promise<void>

  • Delete a reserved domain.

    Parameters

    • id: any

    Returns Promise<void>

deleteCertificate

  • deleteCertificate(id: any): Promise<void>

  • Detach the certificate attached to a reserved domain.

    Parameters

    • id: any

    Returns Promise<void>

deleteCertificateManagementPolicy

  • deleteCertificateManagementPolicy(id: any): Promise<void>

  • Detach the certificate management policy attached to a reserved domain.

    Parameters

    • id: any

    Returns Promise<void>

get

list

  • List all reserved domains on this account.

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<ReservedDomain[]>

update

Generated using TypeDoc