Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type InsightAuditLogListByInsightParams
- type InsightAuditLogListByInsightParamsFieldChanged
- type InsightAuditLogListByInsightParamsOrder
- type InsightAuditLogListByInsightResponse
- type InsightAuditLogListByInsightResponseFieldChanged
- type InsightAuditLogListParams
- type InsightAuditLogListParamsFieldChanged
- type InsightAuditLogListParamsOrder
- type InsightAuditLogListResponse
- type InsightAuditLogListResponseFieldChanged
- type InsightAuditLogService
- func (r *InsightAuditLogService) List(ctx context.Context, params InsightAuditLogListParams, ...) (res *pagination.CursorPagination[InsightAuditLogListResponse], err error)
- func (r *InsightAuditLogService) ListAutoPaging(ctx context.Context, params InsightAuditLogListParams, ...) *pagination.CursorPaginationAutoPager[InsightAuditLogListResponse]
- func (r *InsightAuditLogService) ListByInsight(ctx context.Context, issueID string, params InsightAuditLogListByInsightParams, ...) (res *pagination.CursorPagination[InsightAuditLogListByInsightResponse], ...)
- func (r *InsightAuditLogService) ListByInsightAutoPaging(ctx context.Context, issueID string, params InsightAuditLogListByInsightParams, ...) *pagination.CursorPaginationAutoPager[InsightAuditLogListByInsightResponse]
- type InsightClassGetParams
- type InsightClassGetResponse
- type InsightClassGetResponseEnvelope
- type InsightClassGetResponseEnvelopeErrors
- type InsightClassGetResponseEnvelopeErrorsSource
- type InsightClassGetResponseEnvelopeMessages
- type InsightClassGetResponseEnvelopeMessagesSource
- type InsightClassGetResponseEnvelopeSuccess
- type InsightClassService
- type InsightClassificationService
- type InsightClassificationUpdateParams
- type InsightClassificationUpdateParamsClassification
- type InsightClassificationUpdateResponse
- type InsightClassificationUpdateResponseError
- type InsightClassificationUpdateResponseErrorsSource
- type InsightClassificationUpdateResponseMessage
- type InsightClassificationUpdateResponseMessagesSource
- type InsightClassificationUpdateResponseSuccess
- type InsightContextGetParams
- type InsightContextGetResponse
- type InsightContextGetResponseEnvelope
- type InsightContextGetResponseEnvelopeErrors
- type InsightContextGetResponseEnvelopeErrorsSource
- type InsightContextGetResponseEnvelopeMessages
- type InsightContextGetResponseEnvelopeMessagesSource
- type InsightContextGetResponseEnvelopeSuccess
- type InsightContextService
- type InsightDismissParams
- type InsightDismissResponse
- type InsightDismissResponseError
- type InsightDismissResponseErrorsSource
- type InsightDismissResponseMessage
- type InsightDismissResponseMessagesSource
- type InsightDismissResponseSuccess
- type InsightListParams
- type InsightListResponse
- type InsightListResponseIssue
- type InsightListResponseIssuesPayload
- type InsightListResponseIssuesSeverity
- type InsightListResponseIssuesStatus
- type InsightListResponseIssuesUserClassification
- type InsightService
- func (r *InsightService) Dismiss(ctx context.Context, issueID string, params InsightDismissParams, ...) (res *InsightDismissResponse, err error)
- func (r *InsightService) List(ctx context.Context, params InsightListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[InsightListResponse], err error)
- func (r *InsightService) ListAutoPaging(ctx context.Context, params InsightListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[InsightListResponse]
- type InsightSeverityGetParams
- type InsightSeverityGetResponse
- type InsightSeverityGetResponseEnvelope
- type InsightSeverityGetResponseEnvelopeErrors
- type InsightSeverityGetResponseEnvelopeErrorsSource
- type InsightSeverityGetResponseEnvelopeMessages
- type InsightSeverityGetResponseEnvelopeMessagesSource
- type InsightSeverityGetResponseEnvelopeSuccess
- type InsightSeverityService
- type InsightTypeGetParams
- type InsightTypeGetResponse
- type InsightTypeGetResponseEnvelope
- type InsightTypeGetResponseEnvelopeErrors
- type InsightTypeGetResponseEnvelopeErrorsSource
- type InsightTypeGetResponseEnvelopeMessages
- type InsightTypeGetResponseEnvelopeMessagesSource
- type InsightTypeGetResponseEnvelopeSuccess
- type InsightTypeService
- 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 Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SecurityCenterService
- 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 TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- 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 CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
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 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 ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type InsightAuditLogListByInsightParams ¶
type InsightAuditLogListByInsightParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
// Filter entries changed before this timestamp (RFC 3339).
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Filter by the actor that made the change.
ChangedBy param.Field[string] `query:"changed_by"`
// Opaque cursor for pagination. Use the cursor value from result_info of the
// previous response.
Cursor param.Field[string] `query:"cursor"`
// Filter by the field that was changed.
FieldChanged param.Field[InsightAuditLogListByInsightParamsFieldChanged] `query:"field_changed"`
// Sort order for results. Use 'asc' for oldest first or 'desc' for newest first.
Order param.Field[InsightAuditLogListByInsightParamsOrder] `query:"order"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
// Filter entries changed at or after this timestamp (RFC 3339).
Since param.Field[time.Time] `query:"since" format:"date-time"`
}
func (InsightAuditLogListByInsightParams) URLQuery ¶
func (r InsightAuditLogListByInsightParams) URLQuery() (v url.Values)
URLQuery serializes InsightAuditLogListByInsightParams's query parameters as `url.Values`.
type InsightAuditLogListByInsightParamsFieldChanged ¶
type InsightAuditLogListByInsightParamsFieldChanged string
Filter by the field that was changed.
const ( InsightAuditLogListByInsightParamsFieldChangedStatus InsightAuditLogListByInsightParamsFieldChanged = "status" InsightAuditLogListByInsightParamsFieldChangedUserClassification InsightAuditLogListByInsightParamsFieldChanged = "user_classification" )
func (InsightAuditLogListByInsightParamsFieldChanged) IsKnown ¶
func (r InsightAuditLogListByInsightParamsFieldChanged) IsKnown() bool
type InsightAuditLogListByInsightParamsOrder ¶
type InsightAuditLogListByInsightParamsOrder string
Sort order for results. Use 'asc' for oldest first or 'desc' for newest first.
const ( InsightAuditLogListByInsightParamsOrderAsc InsightAuditLogListByInsightParamsOrder = "asc" InsightAuditLogListByInsightParamsOrderDesc InsightAuditLogListByInsightParamsOrder = "desc" )
func (InsightAuditLogListByInsightParamsOrder) IsKnown ¶
func (r InsightAuditLogListByInsightParamsOrder) IsKnown() bool
type InsightAuditLogListByInsightResponse ¶
type InsightAuditLogListByInsightResponse struct {
// UUIDv7 identifier for the audit log entry, time-ordered.
ID string `json:"id" format:"uuid"`
// The timestamp when the change occurred.
ChangedAt time.Time `json:"changed_at" format:"date-time"`
// The actor that made the change. 'system' for automated changes, or a user
// identifier.
ChangedBy string `json:"changed_by"`
// The value of the field after the change. Null if the field was cleared.
CurrentValue string `json:"current_value" api:"nullable"`
// The field that was changed.
FieldChanged InsightAuditLogListByInsightResponseFieldChanged `json:"field_changed"`
// The ID of the insight this audit log entry relates to.
IssueID string `json:"issue_id"`
// The value of the field before the change. Null if the field was not previously
// set.
PreviousValue string `json:"previous_value" api:"nullable"`
// Optional rationale provided for the change.
Rationale string `json:"rationale" api:"nullable"`
// The zone ID associated with the insight. Only present for zone-level insights.
ZoneID int64 `json:"zone_id"`
JSON insightAuditLogListByInsightResponseJSON `json:"-"`
}
func (*InsightAuditLogListByInsightResponse) UnmarshalJSON ¶
func (r *InsightAuditLogListByInsightResponse) UnmarshalJSON(data []byte) (err error)
type InsightAuditLogListByInsightResponseFieldChanged ¶
type InsightAuditLogListByInsightResponseFieldChanged string
The field that was changed.
const ( InsightAuditLogListByInsightResponseFieldChangedStatus InsightAuditLogListByInsightResponseFieldChanged = "status" InsightAuditLogListByInsightResponseFieldChangedUserClassification InsightAuditLogListByInsightResponseFieldChanged = "user_classification" )
func (InsightAuditLogListByInsightResponseFieldChanged) IsKnown ¶
func (r InsightAuditLogListByInsightResponseFieldChanged) IsKnown() bool
type InsightAuditLogListParams ¶
type InsightAuditLogListParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
// Filter entries changed before this timestamp (RFC 3339).
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Filter by the actor that made the change.
ChangedBy param.Field[string] `query:"changed_by"`
// Opaque cursor for pagination. Use the cursor value from result_info of the
// previous response.
Cursor param.Field[string] `query:"cursor"`
// Filter by the field that was changed.
FieldChanged param.Field[InsightAuditLogListParamsFieldChanged] `query:"field_changed"`
// Sort order for results. Use 'asc' for oldest first or 'desc' for newest first.
Order param.Field[InsightAuditLogListParamsOrder] `query:"order"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
// Filter entries changed at or after this timestamp (RFC 3339).
Since param.Field[time.Time] `query:"since" format:"date-time"`
}
func (InsightAuditLogListParams) URLQuery ¶
func (r InsightAuditLogListParams) URLQuery() (v url.Values)
URLQuery serializes InsightAuditLogListParams's query parameters as `url.Values`.
type InsightAuditLogListParamsFieldChanged ¶
type InsightAuditLogListParamsFieldChanged string
Filter by the field that was changed.
const ( InsightAuditLogListParamsFieldChangedStatus InsightAuditLogListParamsFieldChanged = "status" InsightAuditLogListParamsFieldChangedUserClassification InsightAuditLogListParamsFieldChanged = "user_classification" )
func (InsightAuditLogListParamsFieldChanged) IsKnown ¶
func (r InsightAuditLogListParamsFieldChanged) IsKnown() bool
type InsightAuditLogListParamsOrder ¶
type InsightAuditLogListParamsOrder string
Sort order for results. Use 'asc' for oldest first or 'desc' for newest first.
const ( InsightAuditLogListParamsOrderAsc InsightAuditLogListParamsOrder = "asc" InsightAuditLogListParamsOrderDesc InsightAuditLogListParamsOrder = "desc" )
func (InsightAuditLogListParamsOrder) IsKnown ¶
func (r InsightAuditLogListParamsOrder) IsKnown() bool
type InsightAuditLogListResponse ¶
type InsightAuditLogListResponse struct {
// UUIDv7 identifier for the audit log entry, time-ordered.
ID string `json:"id" format:"uuid"`
// The timestamp when the change occurred.
ChangedAt time.Time `json:"changed_at" format:"date-time"`
// The actor that made the change. 'system' for automated changes, or a user
// identifier.
ChangedBy string `json:"changed_by"`
// The value of the field after the change. Null if the field was cleared.
CurrentValue string `json:"current_value" api:"nullable"`
// The field that was changed.
FieldChanged InsightAuditLogListResponseFieldChanged `json:"field_changed"`
// The ID of the insight this audit log entry relates to.
IssueID string `json:"issue_id"`
// The value of the field before the change. Null if the field was not previously
// set.
PreviousValue string `json:"previous_value" api:"nullable"`
// Optional rationale provided for the change.
Rationale string `json:"rationale" api:"nullable"`
// The zone ID associated with the insight. Only present for zone-level insights.
ZoneID int64 `json:"zone_id"`
JSON insightAuditLogListResponseJSON `json:"-"`
}
func (*InsightAuditLogListResponse) UnmarshalJSON ¶
func (r *InsightAuditLogListResponse) UnmarshalJSON(data []byte) (err error)
type InsightAuditLogListResponseFieldChanged ¶
type InsightAuditLogListResponseFieldChanged string
The field that was changed.
const ( InsightAuditLogListResponseFieldChangedStatus InsightAuditLogListResponseFieldChanged = "status" InsightAuditLogListResponseFieldChangedUserClassification InsightAuditLogListResponseFieldChanged = "user_classification" )
func (InsightAuditLogListResponseFieldChanged) IsKnown ¶
func (r InsightAuditLogListResponseFieldChanged) IsKnown() bool
type InsightAuditLogService ¶
type InsightAuditLogService struct {
Options []option.RequestOption
}
InsightAuditLogService 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 NewInsightAuditLogService method instead.
func NewInsightAuditLogService ¶
func NewInsightAuditLogService(opts ...option.RequestOption) (r *InsightAuditLogService)
NewInsightAuditLogService 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 (*InsightAuditLogService) List ¶
func (r *InsightAuditLogService) List(ctx context.Context, params InsightAuditLogListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[InsightAuditLogListResponse], err error)
Lists audit log entries for all Security Center insights in the account or zone, showing changes to insight status and classification.
func (*InsightAuditLogService) ListAutoPaging ¶
func (r *InsightAuditLogService) ListAutoPaging(ctx context.Context, params InsightAuditLogListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[InsightAuditLogListResponse]
Lists audit log entries for all Security Center insights in the account or zone, showing changes to insight status and classification.
func (*InsightAuditLogService) ListByInsight ¶
func (r *InsightAuditLogService) ListByInsight(ctx context.Context, issueID string, params InsightAuditLogListByInsightParams, opts ...option.RequestOption) (res *pagination.CursorPagination[InsightAuditLogListByInsightResponse], err error)
Lists audit log entries for a specific Security Center insight, showing changes to its status and classification over time.
func (*InsightAuditLogService) ListByInsightAutoPaging ¶
func (r *InsightAuditLogService) ListByInsightAutoPaging(ctx context.Context, issueID string, params InsightAuditLogListByInsightParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[InsightAuditLogListByInsightResponse]
Lists audit log entries for a specific Security Center insight, showing changes to its status and classification over time.
type InsightClassGetParams ¶
type InsightClassGetParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
Dismissed param.Field[bool] `query:"dismissed"`
IssueClass param.Field[[]string] `query:"issue_class"`
IssueClassNeq param.Field[[]string] `query:"issue_class~neq"`
IssueType param.Field[[]intel.IssueType] `query:"issue_type"`
IssueTypeNeq param.Field[[]intel.IssueType] `query:"issue_type~neq"`
Product param.Field[[]string] `query:"product"`
ProductNeq param.Field[[]string] `query:"product~neq"`
Severity param.Field[[]intel.SeverityQueryParam] `query:"severity"`
SeverityNeq param.Field[[]intel.SeverityQueryParam] `query:"severity~neq"`
Subject param.Field[[]string] `query:"subject"`
SubjectNeq param.Field[[]string] `query:"subject~neq"`
}
func (InsightClassGetParams) URLQuery ¶
func (r InsightClassGetParams) URLQuery() (v url.Values)
URLQuery serializes InsightClassGetParams's query parameters as `url.Values`.
type InsightClassGetResponse ¶
type InsightClassGetResponse struct {
Count int64 `json:"count"`
Value string `json:"value"`
JSON insightClassGetResponseJSON `json:"-"`
}
func (*InsightClassGetResponse) UnmarshalJSON ¶
func (r *InsightClassGetResponse) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelope ¶
type InsightClassGetResponseEnvelope struct {
Errors []InsightClassGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []InsightClassGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightClassGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result []InsightClassGetResponse `json:"result"`
JSON insightClassGetResponseEnvelopeJSON `json:"-"`
}
func (*InsightClassGetResponseEnvelope) UnmarshalJSON ¶
func (r *InsightClassGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelopeErrors ¶
type InsightClassGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightClassGetResponseEnvelopeErrorsSource `json:"source"`
JSON insightClassGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*InsightClassGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *InsightClassGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelopeErrorsSource ¶
type InsightClassGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightClassGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*InsightClassGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *InsightClassGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelopeMessages ¶
type InsightClassGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightClassGetResponseEnvelopeMessagesSource `json:"source"`
JSON insightClassGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*InsightClassGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *InsightClassGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelopeMessagesSource ¶
type InsightClassGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightClassGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*InsightClassGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *InsightClassGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightClassGetResponseEnvelopeSuccess ¶
type InsightClassGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
InsightClassGetResponseEnvelopeSuccessTrue InsightClassGetResponseEnvelopeSuccess = true
)
func (InsightClassGetResponseEnvelopeSuccess) IsKnown ¶
func (r InsightClassGetResponseEnvelopeSuccess) IsKnown() bool
type InsightClassService ¶
type InsightClassService struct {
Options []option.RequestOption
}
InsightClassService 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 NewInsightClassService method instead.
func NewInsightClassService ¶
func NewInsightClassService(opts ...option.RequestOption) (r *InsightClassService)
NewInsightClassService 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 (*InsightClassService) Get ¶
func (r *InsightClassService) Get(ctx context.Context, params InsightClassGetParams, opts ...option.RequestOption) (res *[]InsightClassGetResponse, err error)
Retrieves Security Center insight counts aggregated by classification class.
type InsightClassificationService ¶
type InsightClassificationService struct {
Options []option.RequestOption
}
InsightClassificationService 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 NewInsightClassificationService method instead.
func NewInsightClassificationService ¶
func NewInsightClassificationService(opts ...option.RequestOption) (r *InsightClassificationService)
NewInsightClassificationService 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 (*InsightClassificationService) Update ¶
func (r *InsightClassificationService) Update(ctx context.Context, issueID string, params InsightClassificationUpdateParams, opts ...option.RequestOption) (res *InsightClassificationUpdateResponse, err error)
Updates the user classification for a Security Center insight. Valid values are 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot change directly between classification values - must reset to null first.
type InsightClassificationUpdateParams ¶
type InsightClassificationUpdateParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
// User-defined classification for the insight. Can be 'false_positive',
// 'accept_risk', 'other', or null.
Classification param.Field[InsightClassificationUpdateParamsClassification] `json:"classification"`
// Rationale for the classification change. Required when classification is
// 'accept_risk' or 'other'.
Rationale param.Field[string] `json:"rationale"`
}
func (InsightClassificationUpdateParams) MarshalJSON ¶
func (r InsightClassificationUpdateParams) MarshalJSON() (data []byte, err error)
type InsightClassificationUpdateParamsClassification ¶
type InsightClassificationUpdateParamsClassification string
User-defined classification for the insight. Can be 'false_positive', 'accept_risk', 'other', or null.
const ( InsightClassificationUpdateParamsClassificationFalsePositive InsightClassificationUpdateParamsClassification = "false_positive" InsightClassificationUpdateParamsClassificationAcceptRisk InsightClassificationUpdateParamsClassification = "accept_risk" InsightClassificationUpdateParamsClassificationOther InsightClassificationUpdateParamsClassification = "other" )
func (InsightClassificationUpdateParamsClassification) IsKnown ¶
func (r InsightClassificationUpdateParamsClassification) IsKnown() bool
type InsightClassificationUpdateResponse ¶
type InsightClassificationUpdateResponse struct {
Errors []InsightClassificationUpdateResponseError `json:"errors" api:"required"`
Messages []InsightClassificationUpdateResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightClassificationUpdateResponseSuccess `json:"success" api:"required"`
JSON insightClassificationUpdateResponseJSON `json:"-"`
}
func (*InsightClassificationUpdateResponse) UnmarshalJSON ¶
func (r *InsightClassificationUpdateResponse) UnmarshalJSON(data []byte) (err error)
type InsightClassificationUpdateResponseError ¶
type InsightClassificationUpdateResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightClassificationUpdateResponseErrorsSource `json:"source"`
JSON insightClassificationUpdateResponseErrorJSON `json:"-"`
}
func (*InsightClassificationUpdateResponseError) UnmarshalJSON ¶
func (r *InsightClassificationUpdateResponseError) UnmarshalJSON(data []byte) (err error)
type InsightClassificationUpdateResponseErrorsSource ¶
type InsightClassificationUpdateResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightClassificationUpdateResponseErrorsSourceJSON `json:"-"`
}
func (*InsightClassificationUpdateResponseErrorsSource) UnmarshalJSON ¶
func (r *InsightClassificationUpdateResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightClassificationUpdateResponseMessage ¶
type InsightClassificationUpdateResponseMessage struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightClassificationUpdateResponseMessagesSource `json:"source"`
JSON insightClassificationUpdateResponseMessageJSON `json:"-"`
}
func (*InsightClassificationUpdateResponseMessage) UnmarshalJSON ¶
func (r *InsightClassificationUpdateResponseMessage) UnmarshalJSON(data []byte) (err error)
type InsightClassificationUpdateResponseMessagesSource ¶
type InsightClassificationUpdateResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightClassificationUpdateResponseMessagesSourceJSON `json:"-"`
}
func (*InsightClassificationUpdateResponseMessagesSource) UnmarshalJSON ¶
func (r *InsightClassificationUpdateResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightClassificationUpdateResponseSuccess ¶
type InsightClassificationUpdateResponseSuccess bool
Whether the API call was successful.
const (
InsightClassificationUpdateResponseSuccessTrue InsightClassificationUpdateResponseSuccess = true
)
func (InsightClassificationUpdateResponseSuccess) IsKnown ¶
func (r InsightClassificationUpdateResponseSuccess) IsKnown() bool
type InsightContextGetParams ¶
type InsightContextGetResponse ¶
type InsightContextGetResponse map[string]interface{}
type InsightContextGetResponseEnvelope ¶
type InsightContextGetResponseEnvelope struct {
Errors []InsightContextGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []InsightContextGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightContextGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result InsightContextGetResponse `json:"result"`
JSON insightContextGetResponseEnvelopeJSON `json:"-"`
}
func (*InsightContextGetResponseEnvelope) UnmarshalJSON ¶
func (r *InsightContextGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InsightContextGetResponseEnvelopeErrors ¶
type InsightContextGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightContextGetResponseEnvelopeErrorsSource `json:"source"`
JSON insightContextGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*InsightContextGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *InsightContextGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type InsightContextGetResponseEnvelopeErrorsSource ¶
type InsightContextGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightContextGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*InsightContextGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *InsightContextGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightContextGetResponseEnvelopeMessages ¶
type InsightContextGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightContextGetResponseEnvelopeMessagesSource `json:"source"`
JSON insightContextGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*InsightContextGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *InsightContextGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type InsightContextGetResponseEnvelopeMessagesSource ¶
type InsightContextGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightContextGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*InsightContextGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *InsightContextGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightContextGetResponseEnvelopeSuccess ¶
type InsightContextGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
InsightContextGetResponseEnvelopeSuccessTrue InsightContextGetResponseEnvelopeSuccess = true
)
func (InsightContextGetResponseEnvelopeSuccess) IsKnown ¶
func (r InsightContextGetResponseEnvelopeSuccess) IsKnown() bool
type InsightContextService ¶
type InsightContextService struct {
Options []option.RequestOption
}
InsightContextService 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 NewInsightContextService method instead.
func NewInsightContextService ¶
func NewInsightContextService(opts ...option.RequestOption) (r *InsightContextService)
NewInsightContextService 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 (*InsightContextService) Get ¶
func (r *InsightContextService) Get(ctx context.Context, issueID string, query InsightContextGetParams, opts ...option.RequestOption) (res *InsightContextGetResponse, err error)
Returns the full context payload for an insight. This endpoint is used for insights with large payloads that are not included inline in the list response.
type InsightDismissParams ¶
type InsightDismissParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
Dismiss param.Field[bool] `json:"dismiss"`
}
func (InsightDismissParams) MarshalJSON ¶
func (r InsightDismissParams) MarshalJSON() (data []byte, err error)
type InsightDismissResponse ¶
type InsightDismissResponse struct {
Errors []InsightDismissResponseError `json:"errors" api:"required"`
Messages []InsightDismissResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightDismissResponseSuccess `json:"success" api:"required"`
JSON insightDismissResponseJSON `json:"-"`
}
func (*InsightDismissResponse) UnmarshalJSON ¶
func (r *InsightDismissResponse) UnmarshalJSON(data []byte) (err error)
type InsightDismissResponseError ¶
type InsightDismissResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightDismissResponseErrorsSource `json:"source"`
JSON insightDismissResponseErrorJSON `json:"-"`
}
func (*InsightDismissResponseError) UnmarshalJSON ¶
func (r *InsightDismissResponseError) UnmarshalJSON(data []byte) (err error)
type InsightDismissResponseErrorsSource ¶
type InsightDismissResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightDismissResponseErrorsSourceJSON `json:"-"`
}
func (*InsightDismissResponseErrorsSource) UnmarshalJSON ¶
func (r *InsightDismissResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightDismissResponseMessage ¶
type InsightDismissResponseMessage struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightDismissResponseMessagesSource `json:"source"`
JSON insightDismissResponseMessageJSON `json:"-"`
}
func (*InsightDismissResponseMessage) UnmarshalJSON ¶
func (r *InsightDismissResponseMessage) UnmarshalJSON(data []byte) (err error)
type InsightDismissResponseMessagesSource ¶
type InsightDismissResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightDismissResponseMessagesSourceJSON `json:"-"`
}
func (*InsightDismissResponseMessagesSource) UnmarshalJSON ¶
func (r *InsightDismissResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightDismissResponseSuccess ¶
type InsightDismissResponseSuccess bool
Whether the API call was successful.
const (
InsightDismissResponseSuccessTrue InsightDismissResponseSuccess = true
)
func (InsightDismissResponseSuccess) IsKnown ¶
func (r InsightDismissResponseSuccess) IsKnown() bool
type InsightListParams ¶
type InsightListParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
Dismissed param.Field[bool] `query:"dismissed"`
IssueClass param.Field[[]string] `query:"issue_class"`
IssueClassNeq param.Field[[]string] `query:"issue_class~neq"`
IssueType param.Field[[]intel.IssueType] `query:"issue_type"`
IssueTypeNeq param.Field[[]intel.IssueType] `query:"issue_type~neq"`
// Specifies the current page within paginated list of results.
Page param.Field[int64] `query:"page"`
// Sets the number of results per page of results.
PerPage param.Field[int64] `query:"per_page"`
Product param.Field[[]string] `query:"product"`
ProductNeq param.Field[[]string] `query:"product~neq"`
Severity param.Field[[]intel.SeverityQueryParam] `query:"severity"`
SeverityNeq param.Field[[]intel.SeverityQueryParam] `query:"severity~neq"`
Subject param.Field[[]string] `query:"subject"`
SubjectNeq param.Field[[]string] `query:"subject~neq"`
}
func (InsightListParams) URLQuery ¶
func (r InsightListParams) URLQuery() (v url.Values)
URLQuery serializes InsightListParams's query parameters as `url.Values`.
type InsightListResponse ¶
type InsightListResponse struct {
// Indicates the total number of results.
Count int64 `json:"count"`
Issues []InsightListResponseIssue `json:"issues"`
// Specifies the current page within paginated list of results.
Page int64 `json:"page"`
// Sets the number of results per page of results.
PerPage int64 `json:"per_page"`
JSON insightListResponseJSON `json:"-"`
}
func (*InsightListResponse) UnmarshalJSON ¶
func (r *InsightListResponse) UnmarshalJSON(data []byte) (err error)
type InsightListResponseIssue ¶
type InsightListResponseIssue struct {
ID string `json:"id"`
Dismissed bool `json:"dismissed"`
// Indicates whether the insight has a large payload that requires fetching via the
// context endpoint.
HasExtendedContext bool `json:"has_extended_context"`
IssueClass string `json:"issue_class"`
IssueType intel.IssueType `json:"issue_type"`
Payload InsightListResponseIssuesPayload `json:"payload"`
ResolveLink string `json:"resolve_link"`
ResolveText string `json:"resolve_text"`
Severity InsightListResponseIssuesSeverity `json:"severity"`
Since time.Time `json:"since" format:"date-time"`
// The current status of the insight.
Status InsightListResponseIssuesStatus `json:"status"`
Subject string `json:"subject"`
Timestamp time.Time `json:"timestamp" format:"date-time"`
// User-defined classification for the insight. Can be 'false_positive',
// 'accept_risk', 'other', or null.
UserClassification InsightListResponseIssuesUserClassification `json:"user_classification" api:"nullable"`
JSON insightListResponseIssueJSON `json:"-"`
}
func (*InsightListResponseIssue) UnmarshalJSON ¶
func (r *InsightListResponseIssue) UnmarshalJSON(data []byte) (err error)
type InsightListResponseIssuesPayload ¶
type InsightListResponseIssuesPayload struct {
// Describes the method used to detect insight.
DetectionMethod string `json:"detection_method"`
ZoneTag string `json:"zone_tag"`
JSON insightListResponseIssuesPayloadJSON `json:"-"`
}
func (*InsightListResponseIssuesPayload) UnmarshalJSON ¶
func (r *InsightListResponseIssuesPayload) UnmarshalJSON(data []byte) (err error)
type InsightListResponseIssuesSeverity ¶
type InsightListResponseIssuesSeverity string
const ( InsightListResponseIssuesSeverityLow InsightListResponseIssuesSeverity = "Low" InsightListResponseIssuesSeverityModerate InsightListResponseIssuesSeverity = "Moderate" InsightListResponseIssuesSeverityCritical InsightListResponseIssuesSeverity = "Critical" )
func (InsightListResponseIssuesSeverity) IsKnown ¶
func (r InsightListResponseIssuesSeverity) IsKnown() bool
type InsightListResponseIssuesStatus ¶
type InsightListResponseIssuesStatus string
The current status of the insight.
const ( InsightListResponseIssuesStatusActive InsightListResponseIssuesStatus = "active" InsightListResponseIssuesStatusResolved InsightListResponseIssuesStatus = "resolved" )
func (InsightListResponseIssuesStatus) IsKnown ¶
func (r InsightListResponseIssuesStatus) IsKnown() bool
type InsightListResponseIssuesUserClassification ¶
type InsightListResponseIssuesUserClassification string
User-defined classification for the insight. Can be 'false_positive', 'accept_risk', 'other', or null.
const ( InsightListResponseIssuesUserClassificationFalsePositive InsightListResponseIssuesUserClassification = "false_positive" InsightListResponseIssuesUserClassificationAcceptRisk InsightListResponseIssuesUserClassification = "accept_risk" InsightListResponseIssuesUserClassificationOther InsightListResponseIssuesUserClassification = "other" )
func (InsightListResponseIssuesUserClassification) IsKnown ¶
func (r InsightListResponseIssuesUserClassification) IsKnown() bool
type InsightService ¶
type InsightService struct {
Options []option.RequestOption
Class *InsightClassService
Severity *InsightSeverityService
Type *InsightTypeService
AuditLogs *InsightAuditLogService
Classification *InsightClassificationService
Context *InsightContextService
}
InsightService 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 NewInsightService method instead.
func NewInsightService ¶
func NewInsightService(opts ...option.RequestOption) (r *InsightService)
NewInsightService 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 (*InsightService) Dismiss ¶
func (r *InsightService) Dismiss(ctx context.Context, issueID string, params InsightDismissParams, opts ...option.RequestOption) (res *InsightDismissResponse, err error)
Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data.
func (*InsightService) List ¶
func (r *InsightService) List(ctx context.Context, params InsightListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[InsightListResponse], err error)
Lists all Security Center insights for the account or zone, showing security findings and recommendations.
func (*InsightService) ListAutoPaging ¶
func (r *InsightService) ListAutoPaging(ctx context.Context, params InsightListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[InsightListResponse]
Lists all Security Center insights for the account or zone, showing security findings and recommendations.
type InsightSeverityGetParams ¶
type InsightSeverityGetParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
Dismissed param.Field[bool] `query:"dismissed"`
IssueClass param.Field[[]string] `query:"issue_class"`
IssueClassNeq param.Field[[]string] `query:"issue_class~neq"`
IssueType param.Field[[]intel.IssueType] `query:"issue_type"`
IssueTypeNeq param.Field[[]intel.IssueType] `query:"issue_type~neq"`
Product param.Field[[]string] `query:"product"`
ProductNeq param.Field[[]string] `query:"product~neq"`
Severity param.Field[[]intel.SeverityQueryParam] `query:"severity"`
SeverityNeq param.Field[[]intel.SeverityQueryParam] `query:"severity~neq"`
Subject param.Field[[]string] `query:"subject"`
SubjectNeq param.Field[[]string] `query:"subject~neq"`
}
func (InsightSeverityGetParams) URLQuery ¶
func (r InsightSeverityGetParams) URLQuery() (v url.Values)
URLQuery serializes InsightSeverityGetParams's query parameters as `url.Values`.
type InsightSeverityGetResponse ¶
type InsightSeverityGetResponse struct {
Count int64 `json:"count"`
Value string `json:"value"`
JSON insightSeverityGetResponseJSON `json:"-"`
}
func (*InsightSeverityGetResponse) UnmarshalJSON ¶
func (r *InsightSeverityGetResponse) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelope ¶
type InsightSeverityGetResponseEnvelope struct {
Errors []InsightSeverityGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []InsightSeverityGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightSeverityGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result []InsightSeverityGetResponse `json:"result"`
JSON insightSeverityGetResponseEnvelopeJSON `json:"-"`
}
func (*InsightSeverityGetResponseEnvelope) UnmarshalJSON ¶
func (r *InsightSeverityGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelopeErrors ¶
type InsightSeverityGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightSeverityGetResponseEnvelopeErrorsSource `json:"source"`
JSON insightSeverityGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*InsightSeverityGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *InsightSeverityGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelopeErrorsSource ¶
type InsightSeverityGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightSeverityGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*InsightSeverityGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *InsightSeverityGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelopeMessages ¶
type InsightSeverityGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightSeverityGetResponseEnvelopeMessagesSource `json:"source"`
JSON insightSeverityGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*InsightSeverityGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *InsightSeverityGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelopeMessagesSource ¶
type InsightSeverityGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightSeverityGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*InsightSeverityGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *InsightSeverityGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightSeverityGetResponseEnvelopeSuccess ¶
type InsightSeverityGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
InsightSeverityGetResponseEnvelopeSuccessTrue InsightSeverityGetResponseEnvelopeSuccess = true
)
func (InsightSeverityGetResponseEnvelopeSuccess) IsKnown ¶
func (r InsightSeverityGetResponseEnvelopeSuccess) IsKnown() bool
type InsightSeverityService ¶
type InsightSeverityService struct {
Options []option.RequestOption
}
InsightSeverityService 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 NewInsightSeverityService method instead.
func NewInsightSeverityService ¶
func NewInsightSeverityService(opts ...option.RequestOption) (r *InsightSeverityService)
NewInsightSeverityService 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 (*InsightSeverityService) Get ¶
func (r *InsightSeverityService) Get(ctx context.Context, params InsightSeverityGetParams, opts ...option.RequestOption) (res *[]InsightSeverityGetResponse, err error)
Retrieves Security Center insight counts aggregated by severity level (critical, high, medium, low).
type InsightTypeGetParams ¶
type InsightTypeGetParams struct {
// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
AccountID param.Field[string] `path:"account_id"`
// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
ZoneID param.Field[string] `path:"zone_id"`
Dismissed param.Field[bool] `query:"dismissed"`
IssueClass param.Field[[]string] `query:"issue_class"`
IssueClassNeq param.Field[[]string] `query:"issue_class~neq"`
IssueType param.Field[[]intel.IssueType] `query:"issue_type"`
IssueTypeNeq param.Field[[]intel.IssueType] `query:"issue_type~neq"`
Product param.Field[[]string] `query:"product"`
ProductNeq param.Field[[]string] `query:"product~neq"`
Severity param.Field[[]intel.SeverityQueryParam] `query:"severity"`
SeverityNeq param.Field[[]intel.SeverityQueryParam] `query:"severity~neq"`
Subject param.Field[[]string] `query:"subject"`
SubjectNeq param.Field[[]string] `query:"subject~neq"`
}
func (InsightTypeGetParams) URLQuery ¶
func (r InsightTypeGetParams) URLQuery() (v url.Values)
URLQuery serializes InsightTypeGetParams's query parameters as `url.Values`.
type InsightTypeGetResponse ¶
type InsightTypeGetResponse struct {
Count int64 `json:"count"`
Value string `json:"value"`
JSON insightTypeGetResponseJSON `json:"-"`
}
func (*InsightTypeGetResponse) UnmarshalJSON ¶
func (r *InsightTypeGetResponse) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelope ¶
type InsightTypeGetResponseEnvelope struct {
Errors []InsightTypeGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []InsightTypeGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success InsightTypeGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result []InsightTypeGetResponse `json:"result"`
JSON insightTypeGetResponseEnvelopeJSON `json:"-"`
}
func (*InsightTypeGetResponseEnvelope) UnmarshalJSON ¶
func (r *InsightTypeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelopeErrors ¶
type InsightTypeGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightTypeGetResponseEnvelopeErrorsSource `json:"source"`
JSON insightTypeGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*InsightTypeGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *InsightTypeGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelopeErrorsSource ¶
type InsightTypeGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON insightTypeGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*InsightTypeGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *InsightTypeGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelopeMessages ¶
type InsightTypeGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source InsightTypeGetResponseEnvelopeMessagesSource `json:"source"`
JSON insightTypeGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*InsightTypeGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *InsightTypeGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelopeMessagesSource ¶
type InsightTypeGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON insightTypeGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*InsightTypeGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *InsightTypeGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type InsightTypeGetResponseEnvelopeSuccess ¶
type InsightTypeGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
InsightTypeGetResponseEnvelopeSuccessTrue InsightTypeGetResponseEnvelopeSuccess = true
)
func (InsightTypeGetResponseEnvelopeSuccess) IsKnown ¶
func (r InsightTypeGetResponseEnvelopeSuccess) IsKnown() bool
type InsightTypeService ¶
type InsightTypeService struct {
Options []option.RequestOption
}
InsightTypeService 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 NewInsightTypeService method instead.
func NewInsightTypeService ¶
func NewInsightTypeService(opts ...option.RequestOption) (r *InsightTypeService)
NewInsightTypeService 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 (*InsightTypeService) Get ¶
func (r *InsightTypeService) Get(ctx context.Context, params InsightTypeGetParams, opts ...option.RequestOption) (res *[]InsightTypeGetResponse, err error)
Retrieves Security Center insight counts aggregated by insight 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 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 ¶
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 ¶
type ResponseInfoSource = shared.ResponseInfoSource
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 SecurityCenterService ¶
type SecurityCenterService struct {
Options []option.RequestOption
Insights *InsightService
}
SecurityCenterService 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 NewSecurityCenterService method instead.
func NewSecurityCenterService ¶
func NewSecurityCenterService(opts ...option.RequestOption) (r *SecurityCenterService)
NewSecurityCenterService 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 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 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.