Class Zone

Namespace

Cloudflare.NET.Zones.Models

Assembly

Cloudflare.NET.dll

Represents the detailed information for a Cloudflare Zone.

A zone represents a domain and its configuration in Cloudflare. This record captures all properties returned by the Cloudflare API for a zone resource.

public record Zone : IEquatable<Zone>

Inheritance

object

Zone

Implements

IEquatable<Zone>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Zone(string, string, ZoneStatus, ZoneAccount, DateTime?, DateTime, DateTime, int, IReadOnlyList<string>, IReadOnlyList<string>?, string?, string?, ZoneOwner, ZonePlan, ZoneMeta?, bool, IReadOnlyList<string>?, ZoneType, IReadOnlyList<string>?, string?, string?, ZoneTenant?, ZoneTenantUnit?)

Represents the detailed information for a Cloudflare Zone.

A zone represents a domain and its configuration in Cloudflare. This record captures all properties returned by the Cloudflare API for a zone resource.

public Zone(string Id, string Name, ZoneStatus Status, ZoneAccount Account, DateTime? ActivatedOn, DateTime CreatedOn, DateTime ModifiedOn, int DevelopmentMode, IReadOnlyList<string> NameServers, IReadOnlyList<string>? OriginalNameServers, string? OriginalRegistrar, string? OriginalDnsHost, ZoneOwner Owner, ZonePlan Plan, ZoneMeta? Meta, bool Paused, IReadOnlyList<string>? Permissions, ZoneType Type, IReadOnlyList<string>? VanityNameServers, string? CnameSuffix, string? VerificationKey, ZoneTenant? Tenant, ZoneTenantUnit? TenantUnit)

Parameters

Id string

The unique identifier for the zone (32-character hexadecimal string).

Name string

The domain name of the zone (e.g., "example.com").

Status ZoneStatus

The current status of the zone (e.g., active, pending, initializing).

Account ZoneAccount

The account that owns this zone.

ActivatedOn DateTime?

The timestamp when the zone was activated. Null if not yet activated.

CreatedOn DateTime

The timestamp when the zone was created.

ModifiedOn DateTime

The timestamp when the zone was last modified.

DevelopmentMode int

Seconds remaining in development mode. 0 means development mode is off. When enabled, Cloudflare caching is bypassed.

NameServers IReadOnlyList<string>

The Cloudflare-assigned nameservers for the zone.

OriginalNameServers IReadOnlyList<string>

The nameservers that were on the domain before moving to Cloudflare.

OriginalRegistrar string

The registrar that manages the domain.

OriginalDnsHost string

The DNS host that was hosting the domain before moving to Cloudflare.

Owner ZoneOwner

Information about the user who owns the zone.

Plan ZonePlan

The billing plan for the zone.

Meta ZoneMeta

Additional metadata about the zone.

Paused bool

Whether the zone is paused. When paused, Cloudflare stops proxying traffic.

Permissions IReadOnlyList<string>

The permissions the current API token has on this zone.

Type ZoneType

The type of zone setup (full, partial, or secondary).

VanityNameServers IReadOnlyList<string>

Custom nameservers configured for the zone (Business/Enterprise only).

CnameSuffix string

The CNAME suffix for partial zones.

VerificationKey string

The verification key for the zone.

Tenant ZoneTenant

Tenant information for multi-tenant configurations.

TenantUnit ZoneTenantUnit

Tenant unit information for multi-tenant configurations.

See Also

https://developers.cloudflare.com/api/resources/zones/methods/list/

Properties

Account

The account that owns this zone.

[JsonPropertyName("account")]
public ZoneAccount Account { get; init; }

Property Value

ZoneAccount

ActivatedOn

The timestamp when the zone was activated. Null if not yet activated.

[JsonPropertyName("activated_on")]
public DateTime? ActivatedOn { get; init; }

Property Value

DateTime?

CnameSuffix

The CNAME suffix for partial zones.

[JsonPropertyName("cname_suffix")]
public string? CnameSuffix { get; init; }

Property Value

string

CreatedOn

The timestamp when the zone was created.

[JsonPropertyName("created_on")]
public DateTime CreatedOn { get; init; }

Property Value

DateTime

DevelopmentMode

Seconds remaining in development mode. 0 means development mode is off. When enabled, Cloudflare caching is bypassed.

[JsonPropertyName("development_mode")]
public int DevelopmentMode { get; init; }

Property Value

int

Id

The unique identifier for the zone (32-character hexadecimal string).

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

Property Value

string

Meta

Additional metadata about the zone.

[JsonPropertyName("meta")]
public ZoneMeta? Meta { get; init; }

Property Value

ZoneMeta

ModifiedOn

The timestamp when the zone was last modified.

[JsonPropertyName("modified_on")]
public DateTime ModifiedOn { get; init; }

Property Value

DateTime

Name

The domain name of the zone (e.g., "example.com").

[JsonPropertyName("name")]
public string Name { get; init; }

Property Value

string

NameServers

The Cloudflare-assigned nameservers for the zone.

[JsonPropertyName("name_servers")]
public IReadOnlyList<string> NameServers { get; init; }

Property Value

IReadOnlyList<string>

OriginalDnsHost

The DNS host that was hosting the domain before moving to Cloudflare.

[JsonPropertyName("original_dnshost")]
public string? OriginalDnsHost { get; init; }

Property Value

string

OriginalNameServers

The nameservers that were on the domain before moving to Cloudflare.

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

Property Value

IReadOnlyList<string>

OriginalRegistrar

The registrar that manages the domain.

[JsonPropertyName("original_registrar")]
public string? OriginalRegistrar { get; init; }

Property Value

string

Owner

Information about the user who owns the zone.

[JsonPropertyName("owner")]
public ZoneOwner Owner { get; init; }

Property Value

ZoneOwner

Paused

Whether the zone is paused. When paused, Cloudflare stops proxying traffic.

[JsonPropertyName("paused")]
public bool Paused { get; init; }

Property Value

bool

Permissions

The permissions the current API token has on this zone.

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

Property Value

IReadOnlyList<string>

Plan

The billing plan for the zone.

[JsonPropertyName("plan")]
public ZonePlan Plan { get; init; }

Property Value

ZonePlan

Status

The current status of the zone (e.g., active, pending, initializing).

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

Property Value

ZoneStatus

Tenant

Tenant information for multi-tenant configurations.

[JsonPropertyName("tenant")]
public ZoneTenant? Tenant { get; init; }

Property Value

ZoneTenant

TenantUnit

Tenant unit information for multi-tenant configurations.

[JsonPropertyName("tenant_unit")]
public ZoneTenantUnit? TenantUnit { get; init; }

Property Value

ZoneTenantUnit

Type

The type of zone setup (full, partial, or secondary).

[JsonPropertyName("type")]
public ZoneType Type { get; init; }

Property Value

ZoneType

VanityNameServers

Custom nameservers configured for the zone (Business/Enterprise only).

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

Property Value

IReadOnlyList<string>

VerificationKey

The verification key for the zone.

[JsonPropertyName("verification_key")]
public string? VerificationKey { get; init; }

Property Value

string

See Also

https://developers.cloudflare.com/api/resources/zones/methods/list/