Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNDayReportParams
- type ASNDayReportResponse
- type ASNDayReportResponseEnvelope
- type ASNDayReportResponseEnvelopeSuccess
- type ASNFullReportParams
- type ASNFullReportResponse
- type ASNFullReportResponseEnvelope
- type ASNFullReportResponseEnvelopeSuccess
- type ASNParam
- type ASNService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type BotnetFeedService
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type ConfigASNDeleteParams
- type ConfigASNDeleteResponse
- type ConfigASNDeleteResponseEnvelope
- type ConfigASNDeleteResponseEnvelopeSuccess
- type ConfigASNGetParams
- type ConfigASNGetResponse
- type ConfigASNGetResponseEnvelope
- type ConfigASNGetResponseEnvelopeSuccess
- type ConfigASNService
- type ConfigService
- type Error
- type ErrorData
- 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 RatePlanParam
- type ResponseInfo
- 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 TokenStatus
- type TokenValue
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 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 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 ASNDayReportParams ¶
type ASNDayReportParams struct { // Identifier AccountID param.Field[string] `path:"account_id,required"` Date param.Field[time.Time] `query:"date" format:"date-time"` }
func (ASNDayReportParams) URLQuery ¶
func (r ASNDayReportParams) URLQuery() (v url.Values)
URLQuery serializes ASNDayReportParams's query parameters as `url.Values`.
type ASNDayReportResponse ¶
type ASNDayReportResponse struct { CIDR string `json:"cidr"` Date time.Time `json:"date" format:"date-time"` OffenseCount int64 `json:"offense_count"` JSON asnDayReportResponseJSON `json:"-"` }
func (*ASNDayReportResponse) UnmarshalJSON ¶
func (r *ASNDayReportResponse) UnmarshalJSON(data []byte) (err error)
type ASNDayReportResponseEnvelope ¶
type ASNDayReportResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success ASNDayReportResponseEnvelopeSuccess `json:"success,required"` Result ASNDayReportResponse `json:"result"` JSON asnDayReportResponseEnvelopeJSON `json:"-"` }
func (*ASNDayReportResponseEnvelope) UnmarshalJSON ¶
func (r *ASNDayReportResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ASNDayReportResponseEnvelopeSuccess ¶
type ASNDayReportResponseEnvelopeSuccess bool
Whether the API call was successful
const (
ASNDayReportResponseEnvelopeSuccessTrue ASNDayReportResponseEnvelopeSuccess = true
)
func (ASNDayReportResponseEnvelopeSuccess) IsKnown ¶
func (r ASNDayReportResponseEnvelopeSuccess) IsKnown() bool
type ASNFullReportParams ¶
type ASNFullReportResponse ¶
type ASNFullReportResponse struct { CIDR string `json:"cidr"` Date time.Time `json:"date" format:"date-time"` OffenseCount int64 `json:"offense_count"` JSON asnFullReportResponseJSON `json:"-"` }
func (*ASNFullReportResponse) UnmarshalJSON ¶
func (r *ASNFullReportResponse) UnmarshalJSON(data []byte) (err error)
type ASNFullReportResponseEnvelope ¶
type ASNFullReportResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success ASNFullReportResponseEnvelopeSuccess `json:"success,required"` Result ASNFullReportResponse `json:"result"` JSON asnFullReportResponseEnvelopeJSON `json:"-"` }
func (*ASNFullReportResponseEnvelope) UnmarshalJSON ¶
func (r *ASNFullReportResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ASNFullReportResponseEnvelopeSuccess ¶
type ASNFullReportResponseEnvelopeSuccess bool
Whether the API call was successful
const (
ASNFullReportResponseEnvelopeSuccessTrue ASNFullReportResponseEnvelopeSuccess = true
)
func (ASNFullReportResponseEnvelopeSuccess) IsKnown ¶
func (r ASNFullReportResponseEnvelopeSuccess) IsKnown() bool
type ASNService ¶
type ASNService struct {
Options []option.RequestOption
}
ASNService 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 NewASNService method instead.
func NewASNService ¶
func NewASNService(opts ...option.RequestOption) (r *ASNService)
NewASNService 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 (*ASNService) DayReport ¶
func (r *ASNService) DayReport(ctx context.Context, asnID int64, params ASNDayReportParams, opts ...option.RequestOption) (res *ASNDayReportResponse, err error)
Gets all the data the botnet tracking database has for a given ASN registered to user account for given date. If no date is given, it will return results for the previous day.
func (*ASNService) FullReport ¶
func (r *ASNService) FullReport(ctx context.Context, asnID int64, query ASNFullReportParams, opts ...option.RequestOption) (res *ASNFullReportResponse, err error)
Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.
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 BotnetFeedService ¶
type BotnetFeedService struct { Options []option.RequestOption ASN *ASNService Configs *ConfigService }
BotnetFeedService 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 NewBotnetFeedService method instead.
func NewBotnetFeedService ¶
func NewBotnetFeedService(opts ...option.RequestOption) (r *BotnetFeedService)
NewBotnetFeedService 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 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 ConfigASNDeleteParams ¶
type ConfigASNDeleteResponse ¶
type ConfigASNDeleteResponse struct { ASN int64 `json:"asn"` JSON configASNDeleteResponseJSON `json:"-"` }
func (*ConfigASNDeleteResponse) UnmarshalJSON ¶
func (r *ConfigASNDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ConfigASNDeleteResponseEnvelope ¶
type ConfigASNDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success ConfigASNDeleteResponseEnvelopeSuccess `json:"success,required"` Result ConfigASNDeleteResponse `json:"result"` JSON configASNDeleteResponseEnvelopeJSON `json:"-"` }
func (*ConfigASNDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ConfigASNDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConfigASNDeleteResponseEnvelopeSuccess ¶
type ConfigASNDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
ConfigASNDeleteResponseEnvelopeSuccessTrue ConfigASNDeleteResponseEnvelopeSuccess = true
)
func (ConfigASNDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r ConfigASNDeleteResponseEnvelopeSuccess) IsKnown() bool
type ConfigASNGetParams ¶
type ConfigASNGetResponse ¶
type ConfigASNGetResponse struct { ASN int64 `json:"asn"` JSON configASNGetResponseJSON `json:"-"` }
func (*ConfigASNGetResponse) UnmarshalJSON ¶
func (r *ConfigASNGetResponse) UnmarshalJSON(data []byte) (err error)
type ConfigASNGetResponseEnvelope ¶
type ConfigASNGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success ConfigASNGetResponseEnvelopeSuccess `json:"success,required"` Result ConfigASNGetResponse `json:"result"` JSON configASNGetResponseEnvelopeJSON `json:"-"` }
func (*ConfigASNGetResponseEnvelope) UnmarshalJSON ¶
func (r *ConfigASNGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConfigASNGetResponseEnvelopeSuccess ¶
type ConfigASNGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
ConfigASNGetResponseEnvelopeSuccessTrue ConfigASNGetResponseEnvelopeSuccess = true
)
func (ConfigASNGetResponseEnvelopeSuccess) IsKnown ¶
func (r ConfigASNGetResponseEnvelopeSuccess) IsKnown() bool
type ConfigASNService ¶
type ConfigASNService struct {
Options []option.RequestOption
}
ConfigASNService 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 NewConfigASNService method instead.
func NewConfigASNService ¶
func NewConfigASNService(opts ...option.RequestOption) (r *ConfigASNService)
NewConfigASNService 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 (*ConfigASNService) Delete ¶
func (r *ConfigASNService) Delete(ctx context.Context, asnID int64, body ConfigASNDeleteParams, opts ...option.RequestOption) (res *ConfigASNDeleteResponse, err error)
Delete an ASN from botnet threat feed for a given user.
func (*ConfigASNService) Get ¶
func (r *ConfigASNService) Get(ctx context.Context, query ConfigASNGetParams, opts ...option.RequestOption) (res *ConfigASNGetResponse, err error)
Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.
type ConfigService ¶
type ConfigService struct { Options []option.RequestOption ASN *ConfigASNService }
ConfigService 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 NewConfigService method instead.
func NewConfigService ¶
func NewConfigService(opts ...option.RequestOption) (r *ConfigService)
NewConfigService 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 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 RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
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 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 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.