filters

type ASN ¶

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog ¶

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction ¶

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor ¶

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType ¶

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner ¶

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource ¶

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA ¶

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType ¶

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel ¶

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc ¶

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection ¶

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus ¶

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType ¶

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type FilterBulkDeleteParams ¶

type FilterBulkDeleteParams struct {
	// Defines an identifier.
	ZoneID param.Field[string]   `path:"zone_id,required"`
	ID     param.Field[[]string] `query:"id,required"`
}

func (r FilterBulkDeleteParams) URLQuery() (v url.Values)

type FilterBulkDeleteResponse ¶

type FilterBulkDeleteResponse struct {
	// The unique identifier of the filter.
	ID   string                       `json:"id"`
	JSON filterBulkDeleteResponseJSON `json:"-"`
}

func (r *FilterBulkDeleteResponse) UnmarshalJSON(data []byte) (err error)

type FilterBulkDeleteResponseEnvelope ¶

type FilterBulkDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo      `json:"errors,required"`
	Messages []shared.ResponseInfo      `json:"messages,required"`
	Result   []FilterBulkDeleteResponse `json:"result,required,nullable"`
	// Defines whether the API call was successful.
	Success    FilterBulkDeleteResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo FilterBulkDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       filterBulkDeleteResponseEnvelopeJSON       `json:"-"`
}

func (r *FilterBulkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type FilterBulkDeleteResponseEnvelopeResultInfo ¶

type FilterBulkDeleteResponseEnvelopeResultInfo struct {
	// Defines the total number of results for the requested service.
	Count float64 `json:"count"`
	// Defines the current page within paginated list of results.
	Page float64 `json:"page"`
	// Defines the number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Defines the total results available without any search parameters.
	TotalCount float64                                        `json:"total_count"`
	JSON       filterBulkDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (r *FilterBulkDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type FilterBulkDeleteResponseEnvelopeSuccess ¶

type FilterBulkDeleteResponseEnvelopeSuccess bool

Defines whether the API call was successful.

const (
	FilterBulkDeleteResponseEnvelopeSuccessTrue FilterBulkDeleteResponseEnvelopeSuccess = true
)

func (r FilterBulkDeleteResponseEnvelopeSuccess) IsKnown() bool

type FilterBulkUpdateParams ¶

type FilterBulkUpdateParams struct {
	// Defines an identifier.
	ZoneID param.Field[string]          `path:"zone_id,required"`
	Body   []FilterBulkUpdateParamsBody `json:"body,required"`
}

func (r FilterBulkUpdateParams) MarshalJSON() (data []byte, err error)

type FilterBulkUpdateParamsBody ¶

type FilterBulkUpdateParamsBody struct {
	// An informative summary of the filter.
	Description param.Field[string] `json:"description"`
	// The filter expression. For more information, refer to
	// [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
	Expression param.Field[string] `json:"expression"`
	// When true, indicates that the filter is currently paused.
	Paused param.Field[bool] `json:"paused"`
	// A short reference tag. Allows you to select related filters.
	Ref param.Field[string] `json:"ref"`
}

func (r FilterBulkUpdateParamsBody) MarshalJSON() (data []byte, err error)

type FilterDeleteParams ¶

type FilterDeleteParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type FilterDeleteResponse ¶

type FilterDeleteResponse struct {
	// The unique identifier of the filter.
	ID   string                   `json:"id,required"`
	JSON filterDeleteResponseJSON `json:"-"`
}

func (r *FilterDeleteResponse) UnmarshalJSON(data []byte) (err error)

type FilterDeleteResponseEnvelope ¶

type FilterDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   FilterDeleteResponse  `json:"result,required"`
	// Defines whether the API call was successful.
	Success FilterDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    filterDeleteResponseEnvelopeJSON    `json:"-"`
}

func (r *FilterDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type FilterDeleteResponseEnvelopeSuccess ¶

type FilterDeleteResponseEnvelopeSuccess bool

Defines whether the API call was successful.

const (
	FilterDeleteResponseEnvelopeSuccessTrue FilterDeleteResponseEnvelopeSuccess = true
)

func (r FilterDeleteResponseEnvelopeSuccess) IsKnown() bool

type FilterGetParams ¶

type FilterGetParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type FilterGetResponseEnvelope ¶

type FilterGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   FirewallFilter        `json:"result,required"`
	// Defines whether the API call was successful.
	Success FilterGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    filterGetResponseEnvelopeJSON    `json:"-"`
}

func (r *FilterGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type FilterGetResponseEnvelopeSuccess ¶

type FilterGetResponseEnvelopeSuccess bool

Defines whether the API call was successful.

const (
	FilterGetResponseEnvelopeSuccessTrue FilterGetResponseEnvelopeSuccess = true
)

func (r FilterGetResponseEnvelopeSuccess) IsKnown() bool

type FilterListParams ¶

type FilterListParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The unique identifier of the filter.
	ID param.Field[string] `query:"id"`
	// A case-insensitive string to find in the description.
	Description param.Field[string] `query:"description"`
	// A case-insensitive string to find in the expression.
	Expression param.Field[string] `query:"expression"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// When true, indicates that the filter is currently paused.
	Paused param.Field[bool] `query:"paused"`
	// Number of filters per page.
	PerPage param.Field[float64] `query:"per_page"`
	// The filter ref (a short reference tag) to search for. Must be an exact match.
	Ref param.Field[string] `query:"ref"`
}

func (r FilterListParams) URLQuery() (v url.Values)

type FilterNewParams ¶

type FilterNewParams struct {
	// Defines an identifier.
	ZoneID param.Field[string]   `path:"zone_id,required"`
	Body   []FirewallFilterParam `json:"body,required"`
}

func (r FilterNewParams) MarshalJSON() (data []byte, err error)

type FilterUpdateParams ¶

type FilterUpdateParams struct {
	// Defines an identifier.
	ZoneID         param.Field[string] `path:"zone_id,required"`
	FirewallFilter FirewallFilterParam `json:"firewall_filter,required"`
}

func (r FilterUpdateParams) MarshalJSON() (data []byte, err error)

type FilterUpdateResponseEnvelope ¶

type FilterUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   FirewallFilter        `json:"result,required"`
	// Defines whether the API call was successful.
	Success FilterUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    filterUpdateResponseEnvelopeJSON    `json:"-"`
}

func (r *FilterUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type FilterUpdateResponseEnvelopeSuccess ¶

type FilterUpdateResponseEnvelopeSuccess bool

Defines whether the API call was successful.

const (
	FilterUpdateResponseEnvelopeSuccessTrue FilterUpdateResponseEnvelopeSuccess = true
)

func (r FilterUpdateResponseEnvelopeSuccess) IsKnown() bool

type FirewallFilter ¶

type FirewallFilter struct {
	// The unique identifier of the filter.
	ID string `json:"id"`
	// An informative summary of the filter.
	Description string `json:"description"`
	// The filter expression. For more information, refer to
	// [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
	Expression string `json:"expression"`
	// When true, indicates that the filter is currently paused.
	Paused bool `json:"paused"`
	// A short reference tag. Allows you to select related filters.
	Ref  string             `json:"ref"`
	JSON firewallFilterJSON `json:"-"`
}

func (r FirewallFilter) ImplementsFirewallRuleFilter()

func (r *FirewallFilter) UnmarshalJSON(data []byte) (err error)

type FirewallFilterParam ¶

type FirewallFilterParam struct {
	// An informative summary of the filter.
	Description param.Field[string] `json:"description"`
	// The filter expression. For more information, refer to
	// [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
	Expression param.Field[string] `json:"expression"`
	// When true, indicates that the filter is currently paused.
	Paused param.Field[bool] `json:"paused"`
	// A short reference tag. Allows you to select related filters.
	Ref param.Field[string] `json:"ref"`
}

func (r FirewallFilterParam) MarshalJSON() (data []byte, err error)

type Member ¶

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy ¶

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission ¶

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan ¶

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam ¶

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection ¶

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription ¶

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token ¶

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus ¶

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue ¶

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.