security_center

package
v6.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 2, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type 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,required"`
	Messages []InsightClassGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success InsightClassGetResponseEnvelopeSuccess `json:"success,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,required"`
	Message          string                                      `json:"message,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,required"`
	Message          string                                        `json:"message,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

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

Get Security Center Insight Counts by Class

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,required"`
	Messages []InsightDismissResponseMessage `json:"messages,required"`
	// Whether the API call was successful.
	Success InsightDismissResponseSuccess `json:"success,required"`
	JSON    insightDismissResponseJSON    `json:"-"`
}

func (*InsightDismissResponse) UnmarshalJSON

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

type InsightDismissResponseError

type InsightDismissResponseError struct {
	Code             int64                              `json:"code,required"`
	Message          string                             `json:"message,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,required"`
	Message          string                               `json:"message,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"`
	// Current page within paginated list of results
	Page param.Field[int64] `query:"page"`
	// 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 {
	// Total number of results
	Count  int64                      `json:"count"`
	Issues []InsightListResponseIssue `json:"issues"`
	// Current page within paginated list of results
	Page int64 `json:"page"`
	// 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"`
	IssueClass  string                            `json:"issue_class"`
	IssueType   intel.IssueType                   `json:"issue_type"`
	Payload     interface{}                       `json:"payload"`
	ResolveLink string                            `json:"resolve_link"`
	ResolveText string                            `json:"resolve_text"`
	Severity    InsightListResponseIssuesSeverity `json:"severity"`
	Since       time.Time                         `json:"since" format:"date-time"`
	Subject     string                            `json:"subject"`
	Timestamp   time.Time                         `json:"timestamp" format:"date-time"`
	JSON        insightListResponseIssueJSON      `json:"-"`
}

func (*InsightListResponseIssue) UnmarshalJSON

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

type InsightListResponseIssuesSeverity

type InsightListResponseIssuesSeverity string
const (
	InsightListResponseIssuesSeverityLow      InsightListResponseIssuesSeverity = "Low"
	InsightListResponseIssuesSeverityModerate InsightListResponseIssuesSeverity = "Moderate"
	InsightListResponseIssuesSeverityCritical InsightListResponseIssuesSeverity = "Critical"
)

func (InsightListResponseIssuesSeverity) IsKnown

type InsightService

type InsightService struct {
	Options  []option.RequestOption
	Class    *InsightClassService
	Severity *InsightSeverityService
	Type     *InsightTypeService
}

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)

Archive Security Center Insight

func (*InsightService) List

Get Security Center Insights

func (*InsightService) ListAutoPaging

Get Security Center Insights

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,required"`
	Messages []InsightSeverityGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success InsightSeverityGetResponseEnvelopeSuccess `json:"success,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,required"`
	Message          string                                         `json:"message,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,required"`
	Message          string                                           `json:"message,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

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

Get Security Center Insight Counts by Severity

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,required"`
	Messages []InsightTypeGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success InsightTypeGetResponseEnvelopeSuccess `json:"success,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,required"`
	Message          string                                     `json:"message,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,required"`
	Message          string                                       `json:"message,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

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

Get Security Center Insight Counts by Type

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type 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 Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL