Struct ReservedDomain

pub struct ReservedDomain {
    pub id: String,
    pub uri: String,
    pub created_at: String,
    pub description: String,
    pub metadata: String,
    pub domain: String,
    pub region: String,
    pub cname_target: Option<String>,
    pub certificate: Option<Ref>,
    pub certificate_management_policy: Option<ReservedDomainCertPolicy>,
    pub certificate_management_status: Option<ReservedDomainCertStatus>,
    pub acme_challenge_cname_target: Option<String>,
}

Fields

id: String

unique reserved domain resource identifier

uri: String

URI of the reserved domain API resource

created_at: String

timestamp when the reserved domain was created, RFC 3339 format

description: String

human-readable description of what this reserved domain will be used for

metadata: String

arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

domain: String

hostname of the reserved domain

region: String

deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)

cname_target: Option<String>

DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app)

certificate: Option<Ref>

object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.

certificate_management_policy: Option<ReservedDomainCertPolicy>

configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled

certificate_management_status: Option<ReservedDomainCertStatus>

status of the automatic certificate management for this domain, or null if automatic management is disabled

acme_challenge_cname_target: Option<String>

DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.

Trait Implementations

impl Clone for ReservedDomain

fn clone(&self) -> ReservedDomain

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReservedDomain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReservedDomain

fn default() -> ReservedDomain

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReservedDomain

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ReservedDomain

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.