Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AnalyticsReportBytimeGetParams
- type AnalyticsReportBytimeGetParamsTimeDelta
- type AnalyticsReportBytimeGetResponseEnvelope
- type AnalyticsReportBytimeGetResponseEnvelopeErrors
- type AnalyticsReportBytimeGetResponseEnvelopeErrorsSource
- type AnalyticsReportBytimeGetResponseEnvelopeMessages
- type AnalyticsReportBytimeGetResponseEnvelopeMessagesSource
- type AnalyticsReportBytimeGetResponseEnvelopeSuccess
- type AnalyticsReportBytimeService
- type AnalyticsReportGetParams
- type AnalyticsReportGetResponseEnvelope
- type AnalyticsReportGetResponseEnvelopeErrors
- type AnalyticsReportGetResponseEnvelopeErrorsSource
- type AnalyticsReportGetResponseEnvelopeMessages
- type AnalyticsReportGetResponseEnvelopeMessagesSource
- type AnalyticsReportGetResponseEnvelopeSuccess
- type AnalyticsReportService
- type AnalyticsService
- type AttackMitigation
- type AttackMitigationParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type DNSFirewallDeleteParams
- type DNSFirewallDeleteResponse
- type DNSFirewallDeleteResponseEnvelope
- type DNSFirewallDeleteResponseEnvelopeErrors
- type DNSFirewallDeleteResponseEnvelopeErrorsSource
- type DNSFirewallDeleteResponseEnvelopeMessages
- type DNSFirewallDeleteResponseEnvelopeMessagesSource
- type DNSFirewallDeleteResponseEnvelopeSuccess
- type DNSFirewallEditParams
- type DNSFirewallEditResponse
- type DNSFirewallEditResponseEnvelope
- type DNSFirewallEditResponseEnvelopeErrors
- type DNSFirewallEditResponseEnvelopeErrorsSource
- type DNSFirewallEditResponseEnvelopeMessages
- type DNSFirewallEditResponseEnvelopeMessagesSource
- type DNSFirewallEditResponseEnvelopeSuccess
- type DNSFirewallGetParams
- type DNSFirewallGetResponse
- type DNSFirewallGetResponseEnvelope
- type DNSFirewallGetResponseEnvelopeErrors
- type DNSFirewallGetResponseEnvelopeErrorsSource
- type DNSFirewallGetResponseEnvelopeMessages
- type DNSFirewallGetResponseEnvelopeMessagesSource
- type DNSFirewallGetResponseEnvelopeSuccess
- type DNSFirewallListParams
- type DNSFirewallListResponse
- type DNSFirewallNewParams
- type DNSFirewallNewResponse
- type DNSFirewallNewResponseEnvelope
- type DNSFirewallNewResponseEnvelopeErrors
- type DNSFirewallNewResponseEnvelopeErrorsSource
- type DNSFirewallNewResponseEnvelopeMessages
- type DNSFirewallNewResponseEnvelopeMessagesSource
- type DNSFirewallNewResponseEnvelopeSuccess
- type DNSFirewallService
- func (r *DNSFirewallService) Delete(ctx context.Context, dnsFirewallID string, body DNSFirewallDeleteParams, ...) (res *DNSFirewallDeleteResponse, err error)
- func (r *DNSFirewallService) Edit(ctx context.Context, dnsFirewallID string, params DNSFirewallEditParams, ...) (res *DNSFirewallEditResponse, err error)
- func (r *DNSFirewallService) Get(ctx context.Context, dnsFirewallID string, query DNSFirewallGetParams, ...) (res *DNSFirewallGetResponse, err error)
- func (r *DNSFirewallService) List(ctx context.Context, params DNSFirewallListParams, ...) (res *pagination.V4PagePaginationArray[DNSFirewallListResponse], err error)
- func (r *DNSFirewallService) ListAutoPaging(ctx context.Context, params DNSFirewallListParams, ...) *pagination.V4PagePaginationArrayAutoPager[DNSFirewallListResponse]
- func (r *DNSFirewallService) New(ctx context.Context, params DNSFirewallNewParams, opts ...option.RequestOption) (res *DNSFirewallNewResponse, err error)
- type Error
- type ErrorData
- type ErrorDataSource
- type FirewallIPs
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type ReverseDNSEditParams
- type ReverseDNSEditResponse
- type ReverseDNSEditResponseEnvelope
- type ReverseDNSEditResponseEnvelopeErrors
- type ReverseDNSEditResponseEnvelopeErrorsSource
- type ReverseDNSEditResponseEnvelopeMessages
- type ReverseDNSEditResponseEnvelopeMessagesSource
- type ReverseDNSEditResponseEnvelopeSuccess
- type ReverseDNSGetParams
- type ReverseDNSGetResponse
- type ReverseDNSGetResponseEnvelope
- type ReverseDNSGetResponseEnvelopeErrors
- type ReverseDNSGetResponseEnvelopeErrorsSource
- type ReverseDNSGetResponseEnvelopeMessages
- type ReverseDNSGetResponseEnvelopeMessagesSource
- type ReverseDNSGetResponseEnvelopeSuccess
- type ReverseDNSService
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesMap
- type TokenPolicyResourcesMapParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type UpstreamIPs
- type UpstreamIPsParam
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalyticsReportBytimeGetParams ¶
type AnalyticsReportBytimeGetParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// A comma-separated list of dimensions to group results by.
Dimensions param.Field[string] `query:"dimensions"`
// Segmentation filter in 'attribute operator value' format.
Filters param.Field[string] `query:"filters"`
// Limit number of returned metrics.
Limit param.Field[int64] `query:"limit"`
// A comma-separated list of metrics to query.
Metrics param.Field[string] `query:"metrics"`
// Start date and time of requesting data period in ISO 8601 format.
Since param.Field[time.Time] `query:"since" format:"date-time"`
// A comma-separated list of dimensions to sort by, where each dimension may be
// prefixed by - (descending) or + (ascending).
Sort param.Field[string] `query:"sort"`
// Unit of time to group data by.
TimeDelta param.Field[AnalyticsReportBytimeGetParamsTimeDelta] `query:"time_delta"`
// End date and time of requesting data period in ISO 8601 format.
Until param.Field[time.Time] `query:"until" format:"date-time"`
}
func (AnalyticsReportBytimeGetParams) URLQuery ¶
func (r AnalyticsReportBytimeGetParams) URLQuery() (v url.Values)
URLQuery serializes AnalyticsReportBytimeGetParams's query parameters as `url.Values`.
type AnalyticsReportBytimeGetParamsTimeDelta ¶
type AnalyticsReportBytimeGetParamsTimeDelta string
Unit of time to group data by.
const ( AnalyticsReportBytimeGetParamsTimeDeltaAll AnalyticsReportBytimeGetParamsTimeDelta = "all" AnalyticsReportBytimeGetParamsTimeDeltaAuto AnalyticsReportBytimeGetParamsTimeDelta = "auto" AnalyticsReportBytimeGetParamsTimeDeltaYear AnalyticsReportBytimeGetParamsTimeDelta = "year" AnalyticsReportBytimeGetParamsTimeDeltaQuarter AnalyticsReportBytimeGetParamsTimeDelta = "quarter" AnalyticsReportBytimeGetParamsTimeDeltaMonth AnalyticsReportBytimeGetParamsTimeDelta = "month" AnalyticsReportBytimeGetParamsTimeDeltaWeek AnalyticsReportBytimeGetParamsTimeDelta = "week" AnalyticsReportBytimeGetParamsTimeDeltaDay AnalyticsReportBytimeGetParamsTimeDelta = "day" AnalyticsReportBytimeGetParamsTimeDeltaHour AnalyticsReportBytimeGetParamsTimeDelta = "hour" AnalyticsReportBytimeGetParamsTimeDeltaDekaminute AnalyticsReportBytimeGetParamsTimeDelta = "dekaminute" AnalyticsReportBytimeGetParamsTimeDeltaMinute AnalyticsReportBytimeGetParamsTimeDelta = "minute" )
func (AnalyticsReportBytimeGetParamsTimeDelta) IsKnown ¶
func (r AnalyticsReportBytimeGetParamsTimeDelta) IsKnown() bool
type AnalyticsReportBytimeGetResponseEnvelope ¶
type AnalyticsReportBytimeGetResponseEnvelope struct {
Errors []AnalyticsReportBytimeGetResponseEnvelopeErrors `json:"errors,required"`
Messages []AnalyticsReportBytimeGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success AnalyticsReportBytimeGetResponseEnvelopeSuccess `json:"success,required"`
Result dns.ByTime `json:"result"`
JSON analyticsReportBytimeGetResponseEnvelopeJSON `json:"-"`
}
func (*AnalyticsReportBytimeGetResponseEnvelope) UnmarshalJSON ¶
func (r *AnalyticsReportBytimeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportBytimeGetResponseEnvelopeErrors ¶ added in v4.5.0
type AnalyticsReportBytimeGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AnalyticsReportBytimeGetResponseEnvelopeErrorsSource `json:"source"`
JSON analyticsReportBytimeGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AnalyticsReportBytimeGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportBytimeGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportBytimeGetResponseEnvelopeErrorsSource ¶ added in v4.5.0
type AnalyticsReportBytimeGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON analyticsReportBytimeGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AnalyticsReportBytimeGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportBytimeGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportBytimeGetResponseEnvelopeMessages ¶ added in v4.5.0
type AnalyticsReportBytimeGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AnalyticsReportBytimeGetResponseEnvelopeMessagesSource `json:"source"`
JSON analyticsReportBytimeGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AnalyticsReportBytimeGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportBytimeGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportBytimeGetResponseEnvelopeMessagesSource ¶ added in v4.5.0
type AnalyticsReportBytimeGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON analyticsReportBytimeGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AnalyticsReportBytimeGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportBytimeGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportBytimeGetResponseEnvelopeSuccess ¶
type AnalyticsReportBytimeGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
AnalyticsReportBytimeGetResponseEnvelopeSuccessTrue AnalyticsReportBytimeGetResponseEnvelopeSuccess = true
)
func (AnalyticsReportBytimeGetResponseEnvelopeSuccess) IsKnown ¶
func (r AnalyticsReportBytimeGetResponseEnvelopeSuccess) IsKnown() bool
type AnalyticsReportBytimeService ¶
type AnalyticsReportBytimeService struct {
Options []option.RequestOption
}
AnalyticsReportBytimeService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnalyticsReportBytimeService method instead.
func NewAnalyticsReportBytimeService ¶
func NewAnalyticsReportBytimeService(opts ...option.RequestOption) (r *AnalyticsReportBytimeService)
NewAnalyticsReportBytimeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AnalyticsReportBytimeService) Get ¶
func (r *AnalyticsReportBytimeService) Get(ctx context.Context, dnsFirewallID string, params AnalyticsReportBytimeGetParams, opts ...option.RequestOption) (res *dns.ByTime, err error)
Retrieves a list of aggregate metrics grouped by time interval.
See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
type AnalyticsReportGetParams ¶
type AnalyticsReportGetParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// A comma-separated list of dimensions to group results by.
Dimensions param.Field[string] `query:"dimensions"`
// Segmentation filter in 'attribute operator value' format.
Filters param.Field[string] `query:"filters"`
// Limit number of returned metrics.
Limit param.Field[int64] `query:"limit"`
// A comma-separated list of metrics to query.
Metrics param.Field[string] `query:"metrics"`
// Start date and time of requesting data period in ISO 8601 format.
Since param.Field[time.Time] `query:"since" format:"date-time"`
// A comma-separated list of dimensions to sort by, where each dimension may be
// prefixed by - (descending) or + (ascending).
Sort param.Field[string] `query:"sort"`
// End date and time of requesting data period in ISO 8601 format.
Until param.Field[time.Time] `query:"until" format:"date-time"`
}
func (AnalyticsReportGetParams) URLQuery ¶
func (r AnalyticsReportGetParams) URLQuery() (v url.Values)
URLQuery serializes AnalyticsReportGetParams's query parameters as `url.Values`.
type AnalyticsReportGetResponseEnvelope ¶
type AnalyticsReportGetResponseEnvelope struct {
Errors []AnalyticsReportGetResponseEnvelopeErrors `json:"errors,required"`
Messages []AnalyticsReportGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success AnalyticsReportGetResponseEnvelopeSuccess `json:"success,required"`
Result dns.Report `json:"result"`
JSON analyticsReportGetResponseEnvelopeJSON `json:"-"`
}
func (*AnalyticsReportGetResponseEnvelope) UnmarshalJSON ¶
func (r *AnalyticsReportGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportGetResponseEnvelopeErrors ¶ added in v4.5.0
type AnalyticsReportGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AnalyticsReportGetResponseEnvelopeErrorsSource `json:"source"`
JSON analyticsReportGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AnalyticsReportGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportGetResponseEnvelopeErrorsSource ¶ added in v4.5.0
type AnalyticsReportGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON analyticsReportGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AnalyticsReportGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportGetResponseEnvelopeMessages ¶ added in v4.5.0
type AnalyticsReportGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AnalyticsReportGetResponseEnvelopeMessagesSource `json:"source"`
JSON analyticsReportGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AnalyticsReportGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportGetResponseEnvelopeMessagesSource ¶ added in v4.5.0
type AnalyticsReportGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON analyticsReportGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AnalyticsReportGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.5.0
func (r *AnalyticsReportGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type AnalyticsReportGetResponseEnvelopeSuccess ¶
type AnalyticsReportGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
AnalyticsReportGetResponseEnvelopeSuccessTrue AnalyticsReportGetResponseEnvelopeSuccess = true
)
func (AnalyticsReportGetResponseEnvelopeSuccess) IsKnown ¶
func (r AnalyticsReportGetResponseEnvelopeSuccess) IsKnown() bool
type AnalyticsReportService ¶
type AnalyticsReportService struct {
Options []option.RequestOption
Bytimes *AnalyticsReportBytimeService
}
AnalyticsReportService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnalyticsReportService method instead.
func NewAnalyticsReportService ¶
func NewAnalyticsReportService(opts ...option.RequestOption) (r *AnalyticsReportService)
NewAnalyticsReportService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AnalyticsReportService) Get ¶
func (r *AnalyticsReportService) Get(ctx context.Context, dnsFirewallID string, params AnalyticsReportGetParams, opts ...option.RequestOption) (res *dns.Report, err error)
Retrieves a list of summarised aggregate metrics over a given time period.
See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
type AnalyticsService ¶
type AnalyticsService struct {
Options []option.RequestOption
Reports *AnalyticsReportService
}
AnalyticsService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnalyticsService method instead.
func NewAnalyticsService ¶
func NewAnalyticsService(opts ...option.RequestOption) (r *AnalyticsService)
NewAnalyticsService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type AttackMitigation ¶
type AttackMitigation struct {
// When enabled, automatically mitigate random-prefix attacks to protect upstream
// DNS servers
Enabled bool `json:"enabled"`
// Only mitigate attacks when upstream servers seem unhealthy
OnlyWhenUpstreamUnhealthy bool `json:"only_when_upstream_unhealthy"`
JSON attackMitigationJSON `json:"-"`
}
Attack mitigation settings
func (*AttackMitigation) UnmarshalJSON ¶
func (r *AttackMitigation) UnmarshalJSON(data []byte) (err error)
type AttackMitigationParam ¶
type AttackMitigationParam struct {
// When enabled, automatically mitigate random-prefix attacks to protect upstream
// DNS servers
Enabled param.Field[bool] `json:"enabled"`
// Only mitigate attacks when upstream servers seem unhealthy
OnlyWhenUpstreamUnhealthy param.Field[bool] `json:"only_when_upstream_unhealthy"`
}
Attack mitigation settings
func (AttackMitigationParam) MarshalJSON ¶
func (r AttackMitigationParam) MarshalJSON() (data []byte, err error)
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 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 DNSFirewallDeleteParams ¶
type DNSFirewallDeleteResponse ¶
type DNSFirewallDeleteResponse struct {
// Identifier.
ID string `json:"id"`
JSON dnsFirewallDeleteResponseJSON `json:"-"`
}
func (*DNSFirewallDeleteResponse) UnmarshalJSON ¶
func (r *DNSFirewallDeleteResponse) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelope ¶
type DNSFirewallDeleteResponseEnvelope struct {
Errors []DNSFirewallDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSFirewallDeleteResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success DNSFirewallDeleteResponseEnvelopeSuccess `json:"success,required"`
Result DNSFirewallDeleteResponse `json:"result"`
JSON dnsFirewallDeleteResponseEnvelopeJSON `json:"-"`
}
func (*DNSFirewallDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *DNSFirewallDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type DNSFirewallDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON dnsFirewallDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSFirewallDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type DNSFirewallDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DNSFirewallDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type DNSFirewallDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON dnsFirewallDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSFirewallDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type DNSFirewallDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DNSFirewallDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallDeleteResponseEnvelopeSuccess ¶
type DNSFirewallDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DNSFirewallDeleteResponseEnvelopeSuccessTrue DNSFirewallDeleteResponseEnvelopeSuccess = true
)
func (DNSFirewallDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r DNSFirewallDeleteResponseEnvelopeSuccess) IsKnown() bool
type DNSFirewallEditParams ¶
type DNSFirewallEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Attack mitigation settings
AttackMitigation param.Field[AttackMitigationParam] `json:"attack_mitigation"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests param.Field[bool] `json:"deprecate_any_requests"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback param.Field[bool] `json:"ecs_fallback"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL param.Field[float64] `json:"maximum_cache_ttl"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL param.Field[float64] `json:"minimum_cache_ttl"`
// DNS Firewall cluster name
Name param.Field[string] `json:"name"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL param.Field[float64] `json:"negative_cache_ttl"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit param.Field[float64] `json:"ratelimit"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries param.Field[float64] `json:"retries"`
UpstreamIPs param.Field[[]UpstreamIPsParam] `json:"upstream_ips" format:"ipv4"`
}
func (DNSFirewallEditParams) MarshalJSON ¶
func (r DNSFirewallEditParams) MarshalJSON() (data []byte, err error)
type DNSFirewallEditResponse ¶
type DNSFirewallEditResponse struct {
// Identifier.
ID string `json:"id,required"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests bool `json:"deprecate_any_requests,required"`
DNSFirewallIPs []FirewallIPs `json:"dns_firewall_ips,required" format:"ipv4"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback bool `json:"ecs_fallback,required"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL float64 `json:"maximum_cache_ttl,required"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL float64 `json:"minimum_cache_ttl,required"`
// Last modification of DNS Firewall cluster
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// DNS Firewall cluster name
Name string `json:"name,required"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL float64 `json:"negative_cache_ttl,required,nullable"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit float64 `json:"ratelimit,required,nullable"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries float64 `json:"retries,required"`
UpstreamIPs []UpstreamIPs `json:"upstream_ips,required" format:"ipv4"`
// Attack mitigation settings
AttackMitigation AttackMitigation `json:"attack_mitigation,nullable"`
JSON dnsFirewallEditResponseJSON `json:"-"`
}
func (*DNSFirewallEditResponse) UnmarshalJSON ¶
func (r *DNSFirewallEditResponse) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelope ¶
type DNSFirewallEditResponseEnvelope struct {
Errors []DNSFirewallEditResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSFirewallEditResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success DNSFirewallEditResponseEnvelopeSuccess `json:"success,required"`
Result DNSFirewallEditResponse `json:"result"`
JSON dnsFirewallEditResponseEnvelopeJSON `json:"-"`
}
func (*DNSFirewallEditResponseEnvelope) UnmarshalJSON ¶
func (r *DNSFirewallEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelopeErrors ¶ added in v4.3.0
type DNSFirewallEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallEditResponseEnvelopeErrorsSource `json:"source"`
JSON dnsFirewallEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSFirewallEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type DNSFirewallEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DNSFirewallEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelopeMessages ¶ added in v4.3.0
type DNSFirewallEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallEditResponseEnvelopeMessagesSource `json:"source"`
JSON dnsFirewallEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSFirewallEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type DNSFirewallEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DNSFirewallEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallEditResponseEnvelopeSuccess ¶
type DNSFirewallEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DNSFirewallEditResponseEnvelopeSuccessTrue DNSFirewallEditResponseEnvelopeSuccess = true
)
func (DNSFirewallEditResponseEnvelopeSuccess) IsKnown ¶
func (r DNSFirewallEditResponseEnvelopeSuccess) IsKnown() bool
type DNSFirewallGetParams ¶
type DNSFirewallGetResponse ¶
type DNSFirewallGetResponse struct {
// Identifier.
ID string `json:"id,required"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests bool `json:"deprecate_any_requests,required"`
DNSFirewallIPs []FirewallIPs `json:"dns_firewall_ips,required" format:"ipv4"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback bool `json:"ecs_fallback,required"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL float64 `json:"maximum_cache_ttl,required"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL float64 `json:"minimum_cache_ttl,required"`
// Last modification of DNS Firewall cluster
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// DNS Firewall cluster name
Name string `json:"name,required"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL float64 `json:"negative_cache_ttl,required,nullable"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit float64 `json:"ratelimit,required,nullable"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries float64 `json:"retries,required"`
UpstreamIPs []UpstreamIPs `json:"upstream_ips,required" format:"ipv4"`
// Attack mitigation settings
AttackMitigation AttackMitigation `json:"attack_mitigation,nullable"`
JSON dnsFirewallGetResponseJSON `json:"-"`
}
func (*DNSFirewallGetResponse) UnmarshalJSON ¶
func (r *DNSFirewallGetResponse) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelope ¶
type DNSFirewallGetResponseEnvelope struct {
Errors []DNSFirewallGetResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSFirewallGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success DNSFirewallGetResponseEnvelopeSuccess `json:"success,required"`
Result DNSFirewallGetResponse `json:"result"`
JSON dnsFirewallGetResponseEnvelopeJSON `json:"-"`
}
func (*DNSFirewallGetResponseEnvelope) UnmarshalJSON ¶
func (r *DNSFirewallGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelopeErrors ¶ added in v4.3.0
type DNSFirewallGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallGetResponseEnvelopeErrorsSource `json:"source"`
JSON dnsFirewallGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSFirewallGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type DNSFirewallGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DNSFirewallGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelopeMessages ¶ added in v4.3.0
type DNSFirewallGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallGetResponseEnvelopeMessagesSource `json:"source"`
JSON dnsFirewallGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSFirewallGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type DNSFirewallGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DNSFirewallGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallGetResponseEnvelopeSuccess ¶
type DNSFirewallGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DNSFirewallGetResponseEnvelopeSuccessTrue DNSFirewallGetResponseEnvelopeSuccess = true
)
func (DNSFirewallGetResponseEnvelopeSuccess) IsKnown ¶
func (r DNSFirewallGetResponseEnvelopeSuccess) IsKnown() bool
type DNSFirewallListParams ¶
type DNSFirewallListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Page number of paginated results
Page param.Field[float64] `query:"page"`
// Number of clusters per page
PerPage param.Field[float64] `query:"per_page"`
}
func (DNSFirewallListParams) URLQuery ¶
func (r DNSFirewallListParams) URLQuery() (v url.Values)
URLQuery serializes DNSFirewallListParams's query parameters as `url.Values`.
type DNSFirewallListResponse ¶
type DNSFirewallListResponse struct {
// Identifier.
ID string `json:"id,required"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests bool `json:"deprecate_any_requests,required"`
DNSFirewallIPs []FirewallIPs `json:"dns_firewall_ips,required" format:"ipv4"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback bool `json:"ecs_fallback,required"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL float64 `json:"maximum_cache_ttl,required"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL float64 `json:"minimum_cache_ttl,required"`
// Last modification of DNS Firewall cluster
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// DNS Firewall cluster name
Name string `json:"name,required"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL float64 `json:"negative_cache_ttl,required,nullable"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit float64 `json:"ratelimit,required,nullable"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries float64 `json:"retries,required"`
UpstreamIPs []UpstreamIPs `json:"upstream_ips,required" format:"ipv4"`
// Attack mitigation settings
AttackMitigation AttackMitigation `json:"attack_mitigation,nullable"`
JSON dnsFirewallListResponseJSON `json:"-"`
}
func (*DNSFirewallListResponse) UnmarshalJSON ¶
func (r *DNSFirewallListResponse) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewParams ¶
type DNSFirewallNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// DNS Firewall cluster name
Name param.Field[string] `json:"name,required"`
UpstreamIPs param.Field[[]UpstreamIPsParam] `json:"upstream_ips,required" format:"ipv4"`
// Attack mitigation settings
AttackMitigation param.Field[AttackMitigationParam] `json:"attack_mitigation"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests param.Field[bool] `json:"deprecate_any_requests"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback param.Field[bool] `json:"ecs_fallback"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL param.Field[float64] `json:"maximum_cache_ttl"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL param.Field[float64] `json:"minimum_cache_ttl"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL param.Field[float64] `json:"negative_cache_ttl"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit param.Field[float64] `json:"ratelimit"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries param.Field[float64] `json:"retries"`
}
func (DNSFirewallNewParams) MarshalJSON ¶
func (r DNSFirewallNewParams) MarshalJSON() (data []byte, err error)
type DNSFirewallNewResponse ¶
type DNSFirewallNewResponse struct {
// Identifier.
ID string `json:"id,required"`
// Whether to refuse to answer queries for the ANY type
DeprecateAnyRequests bool `json:"deprecate_any_requests,required"`
DNSFirewallIPs []FirewallIPs `json:"dns_firewall_ips,required" format:"ipv4"`
// Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
ECSFallback bool `json:"ecs_fallback,required"`
// Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Higher TTLs will be
// decreased to the maximum defined here for caching purposes.
MaximumCacheTTL float64 `json:"maximum_cache_ttl,required"`
// Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
// of caching between DNS Firewall and the upstream servers. Lower TTLs will be
// increased to the minimum defined here for caching purposes.
MinimumCacheTTL float64 `json:"minimum_cache_ttl,required"`
// Last modification of DNS Firewall cluster
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// DNS Firewall cluster name
Name string `json:"name,required"`
// Negative DNS cache TTL This setting controls how long DNS Firewall should cache
// negative responses (e.g., NXDOMAIN) from the upstream servers.
NegativeCacheTTL float64 `json:"negative_cache_ttl,required,nullable"`
// Ratelimit in queries per second per datacenter (applies to DNS queries sent to
// the upstream nameservers configured on the cluster)
Ratelimit float64 `json:"ratelimit,required,nullable"`
// Number of retries for fetching DNS responses from upstream nameservers (not
// counting the initial attempt)
Retries float64 `json:"retries,required"`
UpstreamIPs []UpstreamIPs `json:"upstream_ips,required" format:"ipv4"`
// Attack mitigation settings
AttackMitigation AttackMitigation `json:"attack_mitigation,nullable"`
JSON dnsFirewallNewResponseJSON `json:"-"`
}
func (*DNSFirewallNewResponse) UnmarshalJSON ¶
func (r *DNSFirewallNewResponse) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelope ¶
type DNSFirewallNewResponseEnvelope struct {
Errors []DNSFirewallNewResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSFirewallNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success DNSFirewallNewResponseEnvelopeSuccess `json:"success,required"`
Result DNSFirewallNewResponse `json:"result"`
JSON dnsFirewallNewResponseEnvelopeJSON `json:"-"`
}
func (*DNSFirewallNewResponseEnvelope) UnmarshalJSON ¶
func (r *DNSFirewallNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelopeErrors ¶ added in v4.3.0
type DNSFirewallNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallNewResponseEnvelopeErrorsSource `json:"source"`
JSON dnsFirewallNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSFirewallNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type DNSFirewallNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DNSFirewallNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelopeMessages ¶ added in v4.3.0
type DNSFirewallNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DNSFirewallNewResponseEnvelopeMessagesSource `json:"source"`
JSON dnsFirewallNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSFirewallNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type DNSFirewallNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dnsFirewallNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DNSFirewallNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DNSFirewallNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DNSFirewallNewResponseEnvelopeSuccess ¶
type DNSFirewallNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DNSFirewallNewResponseEnvelopeSuccessTrue DNSFirewallNewResponseEnvelopeSuccess = true
)
func (DNSFirewallNewResponseEnvelopeSuccess) IsKnown ¶
func (r DNSFirewallNewResponseEnvelopeSuccess) IsKnown() bool
type DNSFirewallService ¶
type DNSFirewallService struct {
Options []option.RequestOption
Analytics *AnalyticsService
ReverseDNS *ReverseDNSService
}
DNSFirewallService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDNSFirewallService method instead.
func NewDNSFirewallService ¶
func NewDNSFirewallService(opts ...option.RequestOption) (r *DNSFirewallService)
NewDNSFirewallService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*DNSFirewallService) Delete ¶
func (r *DNSFirewallService) Delete(ctx context.Context, dnsFirewallID string, body DNSFirewallDeleteParams, opts ...option.RequestOption) (res *DNSFirewallDeleteResponse, err error)
Delete a DNS Firewall cluster
func (*DNSFirewallService) Edit ¶
func (r *DNSFirewallService) Edit(ctx context.Context, dnsFirewallID string, params DNSFirewallEditParams, opts ...option.RequestOption) (res *DNSFirewallEditResponse, err error)
Modify the configuration of a DNS Firewall cluster
func (*DNSFirewallService) Get ¶
func (r *DNSFirewallService) Get(ctx context.Context, dnsFirewallID string, query DNSFirewallGetParams, opts ...option.RequestOption) (res *DNSFirewallGetResponse, err error)
Show a single DNS Firewall cluster for an account
func (*DNSFirewallService) List ¶
func (r *DNSFirewallService) List(ctx context.Context, params DNSFirewallListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[DNSFirewallListResponse], err error)
List DNS Firewall clusters for an account
func (*DNSFirewallService) ListAutoPaging ¶
func (r *DNSFirewallService) ListAutoPaging(ctx context.Context, params DNSFirewallListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[DNSFirewallListResponse]
List DNS Firewall clusters for an account
func (*DNSFirewallService) New ¶
func (r *DNSFirewallService) New(ctx context.Context, params DNSFirewallNewParams, opts ...option.RequestOption) (res *DNSFirewallNewResponse, err error)
Create a DNS Firewall cluster
type ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type FirewallIPs ¶
type FirewallIPs = string
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 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 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 RatePlanID ¶ added in v4.1.0
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 ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type ReverseDNSEditParams ¶
type ReverseDNSEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Map of cluster IP addresses to PTR record contents
PTR param.Field[map[string]string] `json:"ptr"`
}
func (ReverseDNSEditParams) MarshalJSON ¶
func (r ReverseDNSEditParams) MarshalJSON() (data []byte, err error)
type ReverseDNSEditResponse ¶
type ReverseDNSEditResponse struct {
// Map of cluster IP addresses to PTR record contents
PTR map[string]string `json:"ptr,required"`
JSON reverseDNSEditResponseJSON `json:"-"`
}
func (*ReverseDNSEditResponse) UnmarshalJSON ¶
func (r *ReverseDNSEditResponse) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelope ¶
type ReverseDNSEditResponseEnvelope struct {
Errors []ReverseDNSEditResponseEnvelopeErrors `json:"errors,required"`
Messages []ReverseDNSEditResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ReverseDNSEditResponseEnvelopeSuccess `json:"success,required"`
Result ReverseDNSEditResponse `json:"result"`
JSON reverseDNSEditResponseEnvelopeJSON `json:"-"`
}
func (*ReverseDNSEditResponseEnvelope) UnmarshalJSON ¶
func (r *ReverseDNSEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelopeErrors ¶ added in v4.3.0
type ReverseDNSEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ReverseDNSEditResponseEnvelopeErrorsSource `json:"source"`
JSON reverseDNSEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ReverseDNSEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ReverseDNSEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON reverseDNSEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ReverseDNSEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelopeMessages ¶ added in v4.3.0
type ReverseDNSEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ReverseDNSEditResponseEnvelopeMessagesSource `json:"source"`
JSON reverseDNSEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ReverseDNSEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ReverseDNSEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON reverseDNSEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ReverseDNSEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ReverseDNSEditResponseEnvelopeSuccess ¶
type ReverseDNSEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ReverseDNSEditResponseEnvelopeSuccessTrue ReverseDNSEditResponseEnvelopeSuccess = true
)
func (ReverseDNSEditResponseEnvelopeSuccess) IsKnown ¶
func (r ReverseDNSEditResponseEnvelopeSuccess) IsKnown() bool
type ReverseDNSGetParams ¶
type ReverseDNSGetResponse ¶
type ReverseDNSGetResponse struct {
// Map of cluster IP addresses to PTR record contents
PTR map[string]string `json:"ptr,required"`
JSON reverseDNSGetResponseJSON `json:"-"`
}
func (*ReverseDNSGetResponse) UnmarshalJSON ¶
func (r *ReverseDNSGetResponse) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelope ¶
type ReverseDNSGetResponseEnvelope struct {
Errors []ReverseDNSGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ReverseDNSGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ReverseDNSGetResponseEnvelopeSuccess `json:"success,required"`
Result ReverseDNSGetResponse `json:"result"`
JSON reverseDNSGetResponseEnvelopeJSON `json:"-"`
}
func (*ReverseDNSGetResponseEnvelope) UnmarshalJSON ¶
func (r *ReverseDNSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelopeErrors ¶ added in v4.3.0
type ReverseDNSGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ReverseDNSGetResponseEnvelopeErrorsSource `json:"source"`
JSON reverseDNSGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ReverseDNSGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ReverseDNSGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON reverseDNSGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ReverseDNSGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelopeMessages ¶ added in v4.3.0
type ReverseDNSGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ReverseDNSGetResponseEnvelopeMessagesSource `json:"source"`
JSON reverseDNSGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ReverseDNSGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ReverseDNSGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON reverseDNSGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ReverseDNSGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ReverseDNSGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ReverseDNSGetResponseEnvelopeSuccess ¶
type ReverseDNSGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ReverseDNSGetResponseEnvelopeSuccessTrue ReverseDNSGetResponseEnvelopeSuccess = true
)
func (ReverseDNSGetResponseEnvelopeSuccess) IsKnown ¶
func (r ReverseDNSGetResponseEnvelopeSuccess) IsKnown() bool
type ReverseDNSService ¶
type ReverseDNSService struct {
Options []option.RequestOption
}
ReverseDNSService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReverseDNSService method instead.
func NewReverseDNSService ¶
func NewReverseDNSService(opts ...option.RequestOption) (r *ReverseDNSService)
NewReverseDNSService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ReverseDNSService) Edit ¶
func (r *ReverseDNSService) Edit(ctx context.Context, dnsFirewallID string, params ReverseDNSEditParams, opts ...option.RequestOption) (res *ReverseDNSEditResponse, err error)
Update reverse DNS configuration (PTR records) for a DNS Firewall cluster
func (*ReverseDNSService) Get ¶
func (r *ReverseDNSService) Get(ctx context.Context, dnsFirewallID string, query ReverseDNSGetParams, opts ...option.RequestOption) (res *ReverseDNSGetResponse, err error)
Show reverse DNS configuration (PTR records) for a DNS Firewall cluster
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 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 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 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 TokenPolicyResourcesMap ¶ added in v4.6.0
type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesMapParam ¶ added in v4.6.0
type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶ added in v4.6.0
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶ added in v4.6.0
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A simple wildcard permission, e.g., "\*".
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.
type UpstreamIPs ¶
type UpstreamIPs = string
type UpstreamIPsParam ¶
type UpstreamIPsParam = string