Class CustomHostname

Namespace

Cloudflare.NET.Zones.CustomHostnames.Models

Assembly

Cloudflare.NET.dll

Represents a custom hostname returned by the Cloudflare API.

public record CustomHostname : IEquatable<CustomHostname>

Inheritance

object

CustomHostname

Implements

IEquatable<CustomHostname>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CustomHostname(string, string, CustomHostnameStatus, SslResponse, OwnershipVerification?, OwnershipVerificationHttp?, IReadOnlyList<string>?, JsonElement?, string?, string?, DateTimeOffset?)

Represents a custom hostname returned by the Cloudflare API.

public CustomHostname(string Id, string Hostname, CustomHostnameStatus Status, SslResponse Ssl, OwnershipVerification? OwnershipVerification = null, OwnershipVerificationHttp? OwnershipVerificationHttp = null, IReadOnlyList<string>? VerificationErrors = null, JsonElement? CustomMetadata = null, string? CustomOriginServer = null, string? CustomOriginSni = null, DateTimeOffset? CreatedAt = null)

Parameters

Id string

The unique identifier of the custom hostname.

Hostname string

The custom hostname (e.g., "app.customer.com").

Status CustomHostnameStatus

The current status of the custom hostname.

Ssl SslResponse

The SSL certificate configuration and status.

OwnershipVerification OwnershipVerification

TXT-based ownership verification information.

OwnershipVerificationHttp OwnershipVerificationHttp

HTTP-based ownership verification information.

VerificationErrors IReadOnlyList<string>

Any errors encountered during hostname verification.

CustomMetadata JsonElement?

Arbitrary JSON metadata associated with this hostname.

CustomOriginServer string

The custom origin server hostname for this custom hostname.

CustomOriginSni string

The SNI value sent to the origin during TLS handshake.

CreatedAt DateTimeOffset?

When the custom hostname was created.

Properties

CreatedAt

When the custom hostname was created.

[JsonPropertyName("created_at")]
public DateTimeOffset? CreatedAt { get; init; }

Property Value

DateTimeOffset?

CustomMetadata

Arbitrary JSON metadata associated with this hostname.

[JsonPropertyName("custom_metadata")]
public JsonElement? CustomMetadata { get; init; }

Property Value

JsonElement?

CustomOriginServer

The custom origin server hostname for this custom hostname.

[JsonPropertyName("custom_origin_server")]
public string? CustomOriginServer { get; init; }

Property Value

string

CustomOriginSni

The SNI value sent to the origin during TLS handshake.

[JsonPropertyName("custom_origin_sni")]
public string? CustomOriginSni { get; init; }

Property Value

string

Hostname

The custom hostname (e.g., "app.customer.com").

[JsonPropertyName("hostname")]
public string Hostname { get; init; }

Property Value

string

Id

The unique identifier of the custom hostname.

[JsonPropertyName("id")]
public string Id { get; init; }

Property Value

string

OwnershipVerification

TXT-based ownership verification information.

[JsonPropertyName("ownership_verification")]
public OwnershipVerification? OwnershipVerification { get; init; }

Property Value

OwnershipVerification

OwnershipVerificationHttp

HTTP-based ownership verification information.

[JsonPropertyName("ownership_verification_http")]
public OwnershipVerificationHttp? OwnershipVerificationHttp { get; init; }

Property Value

OwnershipVerificationHttp

Ssl

The SSL certificate configuration and status.

[JsonPropertyName("ssl")]
public SslResponse Ssl { get; init; }

Property Value

SslResponse

Status

The current status of the custom hostname.

[JsonPropertyName("status")]
public CustomHostnameStatus Status { get; init; }

Property Value

CustomHostnameStatus

VerificationErrors

Any errors encountered during hostname verification.

[JsonPropertyName("verification_errors")]
public IReadOnlyList<string>? VerificationErrors { get; init; }

Property Value

IReadOnlyList<string>