Class CreateRulesetRequest

Namespace

Cloudflare.NET.Security.Rulesets.Models

Assembly

Cloudflare.NET.dll

Defines the request payload for creating a new ruleset.

public record CreateRulesetRequest : IEquatable<CreateRulesetRequest>

Inheritance

object

CreateRulesetRequest

Implements

IEquatable<CreateRulesetRequest>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CreateRulesetRequest(string, string, string?, string?, IReadOnlyList<CreateRuleRequest>?)

Defines the request payload for creating a new ruleset.

public CreateRulesetRequest(string Name, string Kind, string? Description = null, string? Phase = null, IReadOnlyList<CreateRuleRequest>? Rules = null)

Parameters

Name string

The name of the ruleset.

Kind string

The kind of ruleset (e.g., "root", "zone"). This is immutable.

Description string

An optional description for the ruleset.

Phase string

The phase the ruleset belongs to.

Rules IReadOnlyList<CreateRuleRequest>

An optional list of rules to include in the new ruleset.

Properties

Description

An optional description for the ruleset.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

Kind

The kind of ruleset (e.g., "root", "zone"). This is immutable.

[JsonPropertyName("kind")]
public string Kind { get; init; }

Property Value

string

Name

The name of the ruleset.

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

Property Value

string

Phase

The phase the ruleset belongs to.

[JsonPropertyName("phase")]
public string? Phase { get; init; }

Property Value

string

Rules

An optional list of rules to include in the new ruleset.

[JsonPropertyName("rules")]
public IReadOnlyList<CreateRuleRequest>? Rules { get; init; }

Property Value

IReadOnlyList<CreateRuleRequest>