Class ZoneHold

Namespace

Cloudflare.NET.Zones.Models

Assembly

Cloudflare.NET.dll

Represents the zone hold status and configuration.

A zone hold prevents creation and activation of zones with the same hostname. When include_subdomains is enabled, it also blocks all subdomains and SSL4SaaS Custom Hostnames.

Important: Zone holds are an Enterprise-only feature. The Hold property reflects whether the hold is currently active, which depends on whether HoldAfter is in the past.

public record ZoneHold : IEquatable<ZoneHold>

Inheritance

object

ZoneHold

Implements

IEquatable<ZoneHold>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ZoneHold(bool, DateTime?, bool?)

Represents the zone hold status and configuration.

A zone hold prevents creation and activation of zones with the same hostname. When include_subdomains is enabled, it also blocks all subdomains and SSL4SaaS Custom Hostnames.

Important: Zone holds are an Enterprise-only feature. The Hold property reflects whether the hold is currently active, which depends on whether HoldAfter is in the past.

public ZoneHold(bool Hold, DateTime? HoldAfter, bool? IncludeSubdomains)

Parameters

Hold bool

Whether the zone hold is currently active.

This is true only when HoldAfter is in the past.

HoldAfter DateTime?

The date-time when the hold becomes/became active. If this value is in the past, the hold is active (Hold = true).

IncludeSubdomains bool?

Whether the hold extends to all subdomains.

When true, a hold on "example.com" also blocks "staging.example.com", etc.

See Also

https://developers.cloudflare.com/api/resources/zones/subresources/holds/

https://developers.cloudflare.com/fundamentals/account/account-security/zone-holds/

Properties

Hold

Whether the zone hold is currently active.

This is true only when HoldAfter is in the past.

[JsonPropertyName("hold")]
public bool Hold { get; init; }

Property Value

bool

HoldAfter

The date-time when the hold becomes/became active. If this value is in the past, the hold is active (Hold = true).

[JsonPropertyName("hold_after")]
public DateTime? HoldAfter { get; init; }

Property Value

DateTime?

IncludeSubdomains

Whether the hold extends to all subdomains.

When true, a hold on "example.com" also blocks "staging.example.com", etc.

[JsonPropertyName("include_subdomains")]
public bool? IncludeSubdomains { get; init; }

Property Value

bool?

See Also

https://developers.cloudflare.com/api/resources/zones/subresources/holds/

https://developers.cloudflare.com/fundamentals/account/account-security/zone-holds/