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 CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type CloudforceOneService
- type Error
- type ErrorData
- type ErrorDataSource
- type Item
- type ItemStatus
- type ItemTLP
- type Label
- type LabelParam
- type ListItem
- type ListItemPriority
- type ListItemStatus
- type ListItemTLP
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Message
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type Priority
- type PriorityEditParam
- type PriorityEditTLP
- type PriorityTLP
- type Quota
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type RequestAssetDeleteParams
- type RequestAssetDeleteResponse
- type RequestAssetDeleteResponseError
- type RequestAssetDeleteResponseErrorsSource
- type RequestAssetDeleteResponseMessage
- type RequestAssetDeleteResponseMessagesSource
- type RequestAssetDeleteResponseSuccess
- type RequestAssetGetParams
- type RequestAssetGetResponse
- type RequestAssetNewParams
- type RequestAssetNewResponse
- type RequestAssetService
- func (r *RequestAssetService) Delete(ctx context.Context, requestID string, assetID string, ...) (res *RequestAssetDeleteResponse, err error)
- func (r *RequestAssetService) Get(ctx context.Context, requestID string, assetID string, ...) (res *pagination.SinglePage[RequestAssetGetResponse], err error)
- func (r *RequestAssetService) GetAutoPaging(ctx context.Context, requestID string, assetID string, ...) *pagination.SinglePageAutoPager[RequestAssetGetResponse]
- func (r *RequestAssetService) New(ctx context.Context, requestID string, params RequestAssetNewParams, ...) (res *pagination.SinglePage[RequestAssetNewResponse], err error)
- func (r *RequestAssetService) NewAutoPaging(ctx context.Context, requestID string, params RequestAssetNewParams, ...) *pagination.SinglePageAutoPager[RequestAssetNewResponse]
- func (r *RequestAssetService) Update(ctx context.Context, requestID string, assetID string, ...) (res *RequestAssetUpdateResponse, err error)
- type RequestAssetUpdateParams
- type RequestAssetUpdateResponse
- type RequestAssetUpdateResponseEnvelope
- type RequestAssetUpdateResponseEnvelopeErrors
- type RequestAssetUpdateResponseEnvelopeErrorsSource
- type RequestAssetUpdateResponseEnvelopeMessages
- type RequestAssetUpdateResponseEnvelopeMessagesSource
- type RequestAssetUpdateResponseEnvelopeSuccess
- type RequestConstants
- type RequestConstantsParams
- type RequestConstantsPriority
- type RequestConstantsResponseEnvelope
- type RequestConstantsResponseEnvelopeErrors
- type RequestConstantsResponseEnvelopeErrorsSource
- type RequestConstantsResponseEnvelopeMessages
- type RequestConstantsResponseEnvelopeMessagesSource
- type RequestConstantsResponseEnvelopeSuccess
- type RequestConstantsStatus
- type RequestConstantsTLP
- type RequestDeleteParams
- type RequestDeleteResponse
- type RequestDeleteResponseError
- type RequestDeleteResponseErrorsSource
- type RequestDeleteResponseMessage
- type RequestDeleteResponseMessagesSource
- type RequestDeleteResponseSuccess
- type RequestGetParams
- type RequestGetResponseEnvelope
- type RequestGetResponseEnvelopeErrors
- type RequestGetResponseEnvelopeErrorsSource
- type RequestGetResponseEnvelopeMessages
- type RequestGetResponseEnvelopeMessagesSource
- type RequestGetResponseEnvelopeSuccess
- type RequestListParams
- type RequestListParamsSortOrder
- type RequestListParamsStatus
- type RequestMessageDeleteParams
- type RequestMessageDeleteResponse
- type RequestMessageDeleteResponseError
- type RequestMessageDeleteResponseErrorsSource
- type RequestMessageDeleteResponseMessage
- type RequestMessageDeleteResponseMessagesSource
- type RequestMessageDeleteResponseSuccess
- type RequestMessageGetParams
- type RequestMessageGetParamsSortOrder
- type RequestMessageNewParams
- type RequestMessageNewResponseEnvelope
- type RequestMessageNewResponseEnvelopeErrors
- type RequestMessageNewResponseEnvelopeErrorsSource
- type RequestMessageNewResponseEnvelopeMessages
- type RequestMessageNewResponseEnvelopeMessagesSource
- type RequestMessageNewResponseEnvelopeSuccess
- type RequestMessageService
- func (r *RequestMessageService) Delete(ctx context.Context, requestID string, messageID int64, ...) (res *RequestMessageDeleteResponse, err error)
- func (r *RequestMessageService) Get(ctx context.Context, requestID string, params RequestMessageGetParams, ...) (res *pagination.SinglePage[Message], err error)
- func (r *RequestMessageService) GetAutoPaging(ctx context.Context, requestID string, params RequestMessageGetParams, ...) *pagination.SinglePageAutoPager[Message]
- func (r *RequestMessageService) New(ctx context.Context, requestID string, params RequestMessageNewParams, ...) (res *Message, err error)
- func (r *RequestMessageService) Update(ctx context.Context, requestID string, messageID int64, ...) (res *Message, err error)
- type RequestMessageUpdateParams
- type RequestMessageUpdateResponseEnvelope
- type RequestMessageUpdateResponseEnvelopeErrors
- type RequestMessageUpdateResponseEnvelopeErrorsSource
- type RequestMessageUpdateResponseEnvelopeMessages
- type RequestMessageUpdateResponseEnvelopeMessagesSource
- type RequestMessageUpdateResponseEnvelopeSuccess
- type RequestNewParams
- type RequestNewParamsTLP
- type RequestNewResponseEnvelope
- type RequestNewResponseEnvelopeErrors
- type RequestNewResponseEnvelopeErrorsSource
- type RequestNewResponseEnvelopeMessages
- type RequestNewResponseEnvelopeMessagesSource
- type RequestNewResponseEnvelopeSuccess
- type RequestPriorityDeleteParams
- type RequestPriorityDeleteResponse
- type RequestPriorityDeleteResponseError
- type RequestPriorityDeleteResponseErrorsSource
- type RequestPriorityDeleteResponseMessage
- type RequestPriorityDeleteResponseMessagesSource
- type RequestPriorityDeleteResponseSuccess
- type RequestPriorityGetParams
- type RequestPriorityGetResponseEnvelope
- type RequestPriorityGetResponseEnvelopeErrors
- type RequestPriorityGetResponseEnvelopeErrorsSource
- type RequestPriorityGetResponseEnvelopeMessages
- type RequestPriorityGetResponseEnvelopeMessagesSource
- type RequestPriorityGetResponseEnvelopeSuccess
- type RequestPriorityNewParams
- type RequestPriorityNewResponseEnvelope
- type RequestPriorityNewResponseEnvelopeErrors
- type RequestPriorityNewResponseEnvelopeErrorsSource
- type RequestPriorityNewResponseEnvelopeMessages
- type RequestPriorityNewResponseEnvelopeMessagesSource
- type RequestPriorityNewResponseEnvelopeSuccess
- type RequestPriorityQuotaParams
- type RequestPriorityQuotaResponseEnvelope
- type RequestPriorityQuotaResponseEnvelopeErrors
- type RequestPriorityQuotaResponseEnvelopeErrorsSource
- type RequestPriorityQuotaResponseEnvelopeMessages
- type RequestPriorityQuotaResponseEnvelopeMessagesSource
- type RequestPriorityQuotaResponseEnvelopeSuccess
- type RequestPriorityService
- func (r *RequestPriorityService) Delete(ctx context.Context, priorityID string, body RequestPriorityDeleteParams, ...) (res *RequestPriorityDeleteResponse, err error)
- func (r *RequestPriorityService) Get(ctx context.Context, priorityID string, query RequestPriorityGetParams, ...) (res *Item, err error)
- func (r *RequestPriorityService) New(ctx context.Context, params RequestPriorityNewParams, ...) (res *Priority, err error)
- func (r *RequestPriorityService) Quota(ctx context.Context, query RequestPriorityQuotaParams, ...) (res *Quota, err error)
- func (r *RequestPriorityService) Update(ctx context.Context, priorityID string, params RequestPriorityUpdateParams, ...) (res *Item, err error)
- type RequestPriorityUpdateParams
- type RequestPriorityUpdateResponseEnvelope
- type RequestPriorityUpdateResponseEnvelopeErrors
- type RequestPriorityUpdateResponseEnvelopeErrorsSource
- type RequestPriorityUpdateResponseEnvelopeMessages
- type RequestPriorityUpdateResponseEnvelopeMessagesSource
- type RequestPriorityUpdateResponseEnvelopeSuccess
- type RequestQuotaParams
- type RequestQuotaResponseEnvelope
- type RequestQuotaResponseEnvelopeErrors
- type RequestQuotaResponseEnvelopeErrorsSource
- type RequestQuotaResponseEnvelopeMessages
- type RequestQuotaResponseEnvelopeMessagesSource
- type RequestQuotaResponseEnvelopeSuccess
- type RequestService
- func (r *RequestService) Constants(ctx context.Context, query RequestConstantsParams, ...) (res *RequestConstants, err error)
- func (r *RequestService) Delete(ctx context.Context, requestID string, body RequestDeleteParams, ...) (res *RequestDeleteResponse, err error)
- func (r *RequestService) Get(ctx context.Context, requestID string, query RequestGetParams, ...) (res *Item, err error)
- func (r *RequestService) List(ctx context.Context, params RequestListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ListItem], err error)
- func (r *RequestService) ListAutoPaging(ctx context.Context, params RequestListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ListItem]
- func (r *RequestService) New(ctx context.Context, params RequestNewParams, opts ...option.RequestOption) (res *Item, err error)
- func (r *RequestService) Quota(ctx context.Context, query RequestQuotaParams, opts ...option.RequestOption) (res *Quota, err error)
- func (r *RequestService) Types(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)
- func (r *RequestService) TypesAutoPaging(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]
- func (r *RequestService) Update(ctx context.Context, requestID string, params RequestUpdateParams, ...) (res *Item, err error)
- type RequestTypes
- type RequestTypesParams
- type RequestUpdateParams
- type RequestUpdateParamsTLP
- type RequestUpdateResponseEnvelope
- type RequestUpdateResponseEnvelopeErrors
- type RequestUpdateResponseEnvelopeErrorsSource
- type RequestUpdateResponseEnvelopeMessages
- type RequestUpdateResponseEnvelopeMessagesSource
- type RequestUpdateResponseEnvelopeSuccess
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type ScanConfigDeleteParams
- type ScanConfigDeleteResponse
- type ScanConfigDeleteResponseEnvelope
- type ScanConfigEditParams
- type ScanConfigEditResponse
- type ScanConfigEditResponseEnvelope
- type ScanConfigEditResponseEnvelopeErrors
- type ScanConfigEditResponseEnvelopeErrorsSource
- type ScanConfigEditResponseEnvelopeMessages
- type ScanConfigEditResponseEnvelopeMessagesSource
- type ScanConfigEditResponseEnvelopeSuccess
- type ScanConfigListParams
- type ScanConfigListResponse
- type ScanConfigNewParams
- type ScanConfigNewResponse
- type ScanConfigNewResponseEnvelope
- type ScanConfigNewResponseEnvelopeErrors
- type ScanConfigNewResponseEnvelopeErrorsSource
- type ScanConfigNewResponseEnvelopeMessages
- type ScanConfigNewResponseEnvelopeMessagesSource
- type ScanConfigNewResponseEnvelopeSuccess
- type ScanConfigService
- func (r *ScanConfigService) Delete(ctx context.Context, configID string, body ScanConfigDeleteParams, ...) (res *ScanConfigDeleteResponse, err error)
- func (r *ScanConfigService) Edit(ctx context.Context, configID string, params ScanConfigEditParams, ...) (res *ScanConfigEditResponse, err error)
- func (r *ScanConfigService) List(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ScanConfigListResponse], err error)
- func (r *ScanConfigService) ListAutoPaging(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ScanConfigListResponse]
- func (r *ScanConfigService) New(ctx context.Context, params ScanConfigNewParams, opts ...option.RequestOption) (res *ScanConfigNewResponse, err error)
- type ScanResult
- type ScanResultGetParams
- type ScanResultGetResponse
- type ScanResultGetResponseEnvelope
- type ScanResultService
- type ScanService
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type ThreatEventAttackerListParams
- type ThreatEventAttackerListResponse
- type ThreatEventAttackerListResponseItems
- type ThreatEventAttackerService
- type ThreatEventBulkNewParams
- type ThreatEventBulkNewParamsData
- type ThreatEventBulkNewParamsDataRaw
- type ThreatEventCategoryDeleteParams
- type ThreatEventCategoryDeleteResponse
- type ThreatEventCategoryEditParams
- type ThreatEventCategoryEditResponse
- type ThreatEventCategoryGetParams
- type ThreatEventCategoryGetResponse
- type ThreatEventCategoryListParams
- type ThreatEventCategoryListResponse
- type ThreatEventCategoryNewParams
- type ThreatEventCategoryNewResponse
- type ThreatEventCategoryService
- func (r *ThreatEventCategoryService) Delete(ctx context.Context, categoryID string, body ThreatEventCategoryDeleteParams, ...) (res *ThreatEventCategoryDeleteResponse, err error)
- func (r *ThreatEventCategoryService) Edit(ctx context.Context, categoryID string, params ThreatEventCategoryEditParams, ...) (res *ThreatEventCategoryEditResponse, err error)
- func (r *ThreatEventCategoryService) Get(ctx context.Context, categoryID string, query ThreatEventCategoryGetParams, ...) (res *ThreatEventCategoryGetResponse, err error)
- func (r *ThreatEventCategoryService) List(ctx context.Context, query ThreatEventCategoryListParams, ...) (res *[]ThreatEventCategoryListResponse, err error)
- func (r *ThreatEventCategoryService) New(ctx context.Context, params ThreatEventCategoryNewParams, ...) (res *ThreatEventCategoryNewResponse, err error)
- type ThreatEventCountryListParams
- type ThreatEventCountryListResponse
- type ThreatEventCountryListResponseResult
- type ThreatEventCountryService
- type ThreatEventCronEditParams
- type ThreatEventCronEditResponse
- type ThreatEventCronListParams
- type ThreatEventCronListResponse
- type ThreatEventCronService
- type ThreatEventDatasetEditParams
- type ThreatEventDatasetEditResponse
- type ThreatEventDatasetGetParams
- type ThreatEventDatasetGetResponse
- type ThreatEventDatasetHealthGetParams
- type ThreatEventDatasetHealthGetResponse
- type ThreatEventDatasetHealthGetResponseItems
- type ThreatEventDatasetHealthService
- type ThreatEventDatasetListParams
- type ThreatEventDatasetListResponse
- type ThreatEventDatasetNewParams
- type ThreatEventDatasetNewResponse
- type ThreatEventDatasetRawParams
- type ThreatEventDatasetRawResponse
- type ThreatEventDatasetService
- func (r *ThreatEventDatasetService) Edit(ctx context.Context, datasetID string, params ThreatEventDatasetEditParams, ...) (res *ThreatEventDatasetEditResponse, err error)
- func (r *ThreatEventDatasetService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetGetParams, ...) (res *ThreatEventDatasetGetResponse, err error)
- func (r *ThreatEventDatasetService) List(ctx context.Context, query ThreatEventDatasetListParams, ...) (res *[]ThreatEventDatasetListResponse, err error)
- func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventDatasetNewParams, ...) (res *ThreatEventDatasetNewResponse, err error)
- func (r *ThreatEventDatasetService) Raw(ctx context.Context, datasetID string, eventID string, ...) (res *ThreatEventDatasetRawResponse, err error)
- type ThreatEventDeleteParams
- type ThreatEventDeleteResponse
- type ThreatEventEditParams
- type ThreatEventEditResponse
- type ThreatEventEventTagDeleteParams
- type ThreatEventEventTagDeleteResponse
- type ThreatEventEventTagDeleteResponseEnvelope
- type ThreatEventEventTagNewParams
- type ThreatEventEventTagNewResponse
- type ThreatEventEventTagNewResponseEnvelope
- type ThreatEventEventTagService
- func (r *ThreatEventEventTagService) Delete(ctx context.Context, eventID string, body ThreatEventEventTagDeleteParams, ...) (res *ThreatEventEventTagDeleteResponse, err error)
- func (r *ThreatEventEventTagService) New(ctx context.Context, eventID string, params ThreatEventEventTagNewParams, ...) (res *ThreatEventEventTagNewResponse, err error)
- type ThreatEventGetParams
- type ThreatEventGetResponse
- type ThreatEventIndicatorTypeListParams
- type ThreatEventIndicatorTypeListResponse
- type ThreatEventIndicatorTypeListResponseItems
- type ThreatEventIndicatorTypeService
- type ThreatEventInsightDeleteParams
- type ThreatEventInsightDeleteResponse
- type ThreatEventInsightDeleteResponseEnvelope
- type ThreatEventInsightEditParams
- type ThreatEventInsightEditResponse
- type ThreatEventInsightEditResponseEnvelope
- type ThreatEventInsightGetParams
- type ThreatEventInsightGetResponse
- type ThreatEventInsightGetResponseEnvelope
- type ThreatEventInsightNewParams
- type ThreatEventInsightNewResponse
- type ThreatEventInsightNewResponseEnvelope
- type ThreatEventInsightService
- func (r *ThreatEventInsightService) Delete(ctx context.Context, eventID string, insightID string, ...) (res *ThreatEventInsightDeleteResponse, err error)
- func (r *ThreatEventInsightService) Edit(ctx context.Context, eventID string, insightID string, ...) (res *ThreatEventInsightEditResponse, err error)
- func (r *ThreatEventInsightService) Get(ctx context.Context, eventID string, insightID string, ...) (res *ThreatEventInsightGetResponse, err error)
- func (r *ThreatEventInsightService) New(ctx context.Context, eventID string, params ThreatEventInsightNewParams, ...) (res *ThreatEventInsightNewResponse, err error)
- type ThreatEventListParams
- type ThreatEventListParamsOrder
- type ThreatEventListParamsSearch
- type ThreatEventListParamsSearchOp
- type ThreatEventListParamsSearchValueArray
- type ThreatEventListParamsSearchValueArrayItemUnion
- type ThreatEventListParamsSearchValueUnion
- type ThreatEventListResponse
- type ThreatEventNewParams
- type ThreatEventNewParamsRaw
- type ThreatEventNewResponse
- type ThreatEventRawEditParams
- type ThreatEventRawEditResponse
- type ThreatEventRawGetParams
- type ThreatEventRawGetResponse
- type ThreatEventRawService
- type ThreatEventRelateDeleteParams
- type ThreatEventRelateDeleteResponse
- type ThreatEventRelateDeleteResponseEnvelope
- type ThreatEventRelateService
- type ThreatEventService
- func (r *ThreatEventService) BulkNew(ctx context.Context, params ThreatEventBulkNewParams, ...) (res *float64, err error)
- func (r *ThreatEventService) Delete(ctx context.Context, eventID string, body ThreatEventDeleteParams, ...) (res *ThreatEventDeleteResponse, err error)
- func (r *ThreatEventService) Edit(ctx context.Context, eventID string, params ThreatEventEditParams, ...) (res *ThreatEventEditResponse, err error)
- func (r *ThreatEventService) Get(ctx context.Context, eventID string, query ThreatEventGetParams, ...) (res *ThreatEventGetResponse, err error)
- func (r *ThreatEventService) List(ctx context.Context, params ThreatEventListParams, ...) (res *[]ThreatEventListResponse, err error)
- func (r *ThreatEventService) New(ctx context.Context, params ThreatEventNewParams, opts ...option.RequestOption) (res *ThreatEventNewResponse, err error)
- type ThreatEventTagNewParams
- type ThreatEventTagNewResponse
- type ThreatEventTagService
- type ThreatEventTargetIndustryListParams
- type ThreatEventTargetIndustryListResponse
- type ThreatEventTargetIndustryListResponseItems
- type ThreatEventTargetIndustryService
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesMap
- type TokenPolicyResourcesMapParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type CloudforceOneService ¶
type CloudforceOneService struct {
Options []option.RequestOption
Scans *ScanService
Requests *RequestService
ThreatEvents *ThreatEventService
}
CloudforceOneService 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 NewCloudforceOneService method instead.
func NewCloudforceOneService ¶
func NewCloudforceOneService(opts ...option.RequestOption) (r *CloudforceOneService)
NewCloudforceOneService 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 ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type Item ¶
type Item struct {
// UUID.
ID string `json:"id,required"`
// Request content.
Content string `json:"content,required"`
Created time.Time `json:"created,required" format:"date-time"`
Priority time.Time `json:"priority,required" format:"date-time"`
// Requested information from request.
Request string `json:"request,required"`
// Brief description of the request.
Summary string `json:"summary,required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP ItemTLP `json:"tlp,required"`
Updated time.Time `json:"updated,required" format:"date-time"`
Completed time.Time `json:"completed" format:"date-time"`
// Tokens for the request messages.
MessageTokens int64 `json:"message_tokens"`
// Readable Request ID.
ReadableID string `json:"readable_id"`
// Request Status.
Status ItemStatus `json:"status"`
// Tokens for the request.
Tokens int64 `json:"tokens"`
JSON itemJSON `json:"-"`
}
func (*Item) UnmarshalJSON ¶
type ItemStatus ¶
type ItemStatus string
Request Status.
const ( ItemStatusOpen ItemStatus = "open" ItemStatusAccepted ItemStatus = "accepted" ItemStatusReported ItemStatus = "reported" ItemStatusApproved ItemStatus = "approved" ItemStatusCompleted ItemStatus = "completed" ItemStatusDeclined ItemStatus = "declined" )
func (ItemStatus) IsKnown ¶
func (r ItemStatus) IsKnown() bool
type LabelParam ¶
type LabelParam = string
type ListItem ¶
type ListItem struct {
// UUID.
ID string `json:"id,required"`
// Request creation time.
Created time.Time `json:"created,required" format:"date-time"`
Priority ListItemPriority `json:"priority,required"`
// Requested information from request.
Request string `json:"request,required"`
// Brief description of the request.
Summary string `json:"summary,required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP ListItemTLP `json:"tlp,required"`
// Request last updated time.
Updated time.Time `json:"updated,required" format:"date-time"`
// Request completion time.
Completed time.Time `json:"completed" format:"date-time"`
// Tokens for the request messages.
MessageTokens int64 `json:"message_tokens"`
// Readable Request ID.
ReadableID string `json:"readable_id"`
// Request Status.
Status ListItemStatus `json:"status"`
// Tokens for the request.
Tokens int64 `json:"tokens"`
JSON listItemJSON `json:"-"`
}
func (*ListItem) UnmarshalJSON ¶
type ListItemPriority ¶
type ListItemPriority string
const ( ListItemPriorityRoutine ListItemPriority = "routine" ListItemPriorityHigh ListItemPriority = "high" ListItemPriorityUrgent ListItemPriority = "urgent" )
func (ListItemPriority) IsKnown ¶
func (r ListItemPriority) IsKnown() bool
type ListItemStatus ¶
type ListItemStatus string
Request Status.
const ( ListItemStatusOpen ListItemStatus = "open" ListItemStatusAccepted ListItemStatus = "accepted" ListItemStatusReported ListItemStatus = "reported" ListItemStatusApproved ListItemStatus = "approved" ListItemStatusCompleted ListItemStatus = "completed" ListItemStatusDeclined ListItemStatus = "declined" )
func (ListItemStatus) IsKnown ¶
func (r ListItemStatus) IsKnown() bool
type ListItemTLP ¶
type ListItemTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( ListItemTLPClear ListItemTLP = "clear" ListItemTLPAmber ListItemTLP = "amber" ListItemTLPAmberStrict ListItemTLP = "amber-strict" ListItemTLPGreen ListItemTLP = "green" ListItemTLPRed ListItemTLP = "red" )
func (ListItemTLP) IsKnown ¶
func (r ListItemTLP) IsKnown() bool
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 Message ¶
type Message struct {
// Message ID.
ID int64 `json:"id,required"`
// Author of message.
Author string `json:"author,required"`
// Content of message.
Content string `json:"content,required"`
// Whether the message is a follow-on request.
IsFollowOnRequest bool `json:"is_follow_on_request,required"`
// Defines the message last updated time.
Updated time.Time `json:"updated,required" format:"date-time"`
// Defines the message creation time.
Created time.Time `json:"created" format:"date-time"`
JSON messageJSON `json:"-"`
}
func (*Message) UnmarshalJSON ¶
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 Priority ¶
type Priority struct {
// UUID.
ID string `json:"id,required"`
// Priority creation time.
Created time.Time `json:"created,required" format:"date-time"`
// List of labels.
Labels []Label `json:"labels,required"`
// Priority.
Priority int64 `json:"priority,required"`
// Requirement.
Requirement string `json:"requirement,required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP PriorityTLP `json:"tlp,required"`
// Priority last updated time.
Updated time.Time `json:"updated,required" format:"date-time"`
JSON priorityJSON `json:"-"`
}
func (*Priority) UnmarshalJSON ¶
type PriorityEditParam ¶
type PriorityEditParam struct {
// List of labels.
Labels param.Field[[]LabelParam] `json:"labels,required"`
// Priority.
Priority param.Field[int64] `json:"priority,required"`
// Requirement.
Requirement param.Field[string] `json:"requirement,required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP param.Field[PriorityEditTLP] `json:"tlp,required"`
}
func (PriorityEditParam) MarshalJSON ¶
func (r PriorityEditParam) MarshalJSON() (data []byte, err error)
type PriorityEditTLP ¶
type PriorityEditTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( PriorityEditTLPClear PriorityEditTLP = "clear" PriorityEditTLPAmber PriorityEditTLP = "amber" PriorityEditTLPAmberStrict PriorityEditTLP = "amber-strict" PriorityEditTLPGreen PriorityEditTLP = "green" PriorityEditTLPRed PriorityEditTLP = "red" )
func (PriorityEditTLP) IsKnown ¶
func (r PriorityEditTLP) IsKnown() bool
type PriorityTLP ¶
type PriorityTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( PriorityTLPClear PriorityTLP = "clear" PriorityTLPAmber PriorityTLP = "amber" PriorityTLPAmberStrict PriorityTLP = "amber-strict" PriorityTLPGreen PriorityTLP = "green" PriorityTLPRed PriorityTLP = "red" )
func (PriorityTLP) IsKnown ¶
func (r PriorityTLP) IsKnown() bool
type Quota ¶
type Quota struct {
// Anniversary date is when annual quota limit is refreshed.
AnniversaryDate time.Time `json:"anniversary_date" format:"date-time"`
// Quarter anniversary date is when quota limit is refreshed each quarter.
QuarterAnniversaryDate time.Time `json:"quarter_anniversary_date" format:"date-time"`
// Tokens for the quarter.
Quota int64 `json:"quota"`
// Tokens remaining for the quarter.
Remaining int64 `json:"remaining"`
JSON quotaJSON `json:"-"`
}
func (*Quota) UnmarshalJSON ¶
type RatePlanID ¶ added in v4.1.0
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type RequestAssetDeleteParams ¶ added in v4.4.0
type RequestAssetDeleteResponse ¶
type RequestAssetDeleteResponse struct {
Errors []RequestAssetDeleteResponseError `json:"errors,required"`
Messages []RequestAssetDeleteResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success RequestAssetDeleteResponseSuccess `json:"success,required"`
JSON requestAssetDeleteResponseJSON `json:"-"`
}
func (*RequestAssetDeleteResponse) UnmarshalJSON ¶
func (r *RequestAssetDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseError ¶ added in v4.4.0
type RequestAssetDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestAssetDeleteResponseErrorsSource `json:"source"`
JSON requestAssetDeleteResponseErrorJSON `json:"-"`
}
func (*RequestAssetDeleteResponseError) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseErrorsSource ¶ added in v4.4.0
type RequestAssetDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestAssetDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestAssetDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseMessage ¶ added in v4.4.0
type RequestAssetDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestAssetDeleteResponseMessagesSource `json:"source"`
JSON requestAssetDeleteResponseMessageJSON `json:"-"`
}
func (*RequestAssetDeleteResponseMessage) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseMessagesSource ¶ added in v4.4.0
type RequestAssetDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestAssetDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestAssetDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetDeleteResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseSuccess ¶
type RequestAssetDeleteResponseSuccess bool
Whether the API call was successful.
const (
RequestAssetDeleteResponseSuccessTrue RequestAssetDeleteResponseSuccess = true
)
func (RequestAssetDeleteResponseSuccess) IsKnown ¶
func (r RequestAssetDeleteResponseSuccess) IsKnown() bool
type RequestAssetGetParams ¶ added in v4.4.0
type RequestAssetGetResponse ¶
type RequestAssetGetResponse struct {
// Asset ID.
ID int64 `json:"id,required"`
// Asset name.
Name string `json:"name,required"`
// Defines the asset creation time.
Created time.Time `json:"created" format:"date-time"`
// Asset description.
Description string `json:"description"`
// Asset file type.
FileType string `json:"file_type"`
JSON requestAssetGetResponseJSON `json:"-"`
}
func (*RequestAssetGetResponse) UnmarshalJSON ¶
func (r *RequestAssetGetResponse) UnmarshalJSON(data []byte) (err error)
type RequestAssetNewParams ¶
type RequestAssetNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Page number of results.
Page param.Field[int64] `json:"page,required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page,required"`
}
func (RequestAssetNewParams) MarshalJSON ¶
func (r RequestAssetNewParams) MarshalJSON() (data []byte, err error)
type RequestAssetNewResponse ¶
type RequestAssetNewResponse struct {
// Asset ID.
ID int64 `json:"id,required"`
// Asset name.
Name string `json:"name,required"`
// Defines the asset creation time.
Created time.Time `json:"created" format:"date-time"`
// Asset description.
Description string `json:"description"`
// Asset file type.
FileType string `json:"file_type"`
JSON requestAssetNewResponseJSON `json:"-"`
}
func (*RequestAssetNewResponse) UnmarshalJSON ¶
func (r *RequestAssetNewResponse) UnmarshalJSON(data []byte) (err error)
type RequestAssetService ¶
type RequestAssetService struct {
Options []option.RequestOption
}
RequestAssetService 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 NewRequestAssetService method instead.
func NewRequestAssetService ¶
func NewRequestAssetService(opts ...option.RequestOption) (r *RequestAssetService)
NewRequestAssetService 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 (*RequestAssetService) Delete ¶
func (r *RequestAssetService) Delete(ctx context.Context, requestID string, assetID string, body RequestAssetDeleteParams, opts ...option.RequestOption) (res *RequestAssetDeleteResponse, err error)
Delete a Request Asset
func (*RequestAssetService) Get ¶
func (r *RequestAssetService) Get(ctx context.Context, requestID string, assetID string, query RequestAssetGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[RequestAssetGetResponse], err error)
Get a Request Asset
func (*RequestAssetService) GetAutoPaging ¶ added in v4.1.0
func (r *RequestAssetService) GetAutoPaging(ctx context.Context, requestID string, assetID string, query RequestAssetGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetGetResponse]
Get a Request Asset
func (*RequestAssetService) New ¶
func (r *RequestAssetService) New(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[RequestAssetNewResponse], err error)
List Request Assets
func (*RequestAssetService) NewAutoPaging ¶ added in v4.1.0
func (r *RequestAssetService) NewAutoPaging(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetNewResponse]
List Request Assets
func (*RequestAssetService) Update ¶
func (r *RequestAssetService) Update(ctx context.Context, requestID string, assetID string, params RequestAssetUpdateParams, opts ...option.RequestOption) (res *RequestAssetUpdateResponse, err error)
Update a Request Asset
type RequestAssetUpdateParams ¶
type RequestAssetUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Asset file to upload.
Source param.Field[string] `json:"source"`
}
func (RequestAssetUpdateParams) MarshalJSON ¶
func (r RequestAssetUpdateParams) MarshalJSON() (data []byte, err error)
type RequestAssetUpdateResponse ¶
type RequestAssetUpdateResponse struct {
// Asset ID.
ID int64 `json:"id,required"`
// Asset name.
Name string `json:"name,required"`
// Defines the asset creation time.
Created time.Time `json:"created" format:"date-time"`
// Asset description.
Description string `json:"description"`
// Asset file type.
FileType string `json:"file_type"`
JSON requestAssetUpdateResponseJSON `json:"-"`
}
func (*RequestAssetUpdateResponse) UnmarshalJSON ¶
func (r *RequestAssetUpdateResponse) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelope ¶
type RequestAssetUpdateResponseEnvelope struct {
Errors []RequestAssetUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestAssetUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestAssetUpdateResponseEnvelopeSuccess `json:"success,required"`
Result RequestAssetUpdateResponse `json:"result"`
JSON requestAssetUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RequestAssetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeErrors ¶ added in v4.4.0
type RequestAssetUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestAssetUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON requestAssetUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestAssetUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestAssetUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeMessages ¶ added in v4.4.0
type RequestAssetUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestAssetUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON requestAssetUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestAssetUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestAssetUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestAssetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeSuccess ¶
type RequestAssetUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestAssetUpdateResponseEnvelopeSuccessTrue RequestAssetUpdateResponseEnvelopeSuccess = true
)
func (RequestAssetUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RequestAssetUpdateResponseEnvelopeSuccess) IsKnown() bool
type RequestConstants ¶
type RequestConstants struct {
Priority []RequestConstantsPriority `json:"priority"`
Status []RequestConstantsStatus `json:"status"`
TLP []RequestConstantsTLP `json:"tlp"`
JSON requestConstantsJSON `json:"-"`
}
func (*RequestConstants) UnmarshalJSON ¶
func (r *RequestConstants) UnmarshalJSON(data []byte) (err error)
type RequestConstantsParams ¶ added in v4.4.0
type RequestConstantsPriority ¶
type RequestConstantsPriority string
const ( RequestConstantsPriorityRoutine RequestConstantsPriority = "routine" RequestConstantsPriorityHigh RequestConstantsPriority = "high" RequestConstantsPriorityUrgent RequestConstantsPriority = "urgent" )
func (RequestConstantsPriority) IsKnown ¶
func (r RequestConstantsPriority) IsKnown() bool
type RequestConstantsResponseEnvelope ¶
type RequestConstantsResponseEnvelope struct {
Errors []RequestConstantsResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestConstantsResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestConstantsResponseEnvelopeSuccess `json:"success,required"`
Result RequestConstants `json:"result"`
JSON requestConstantsResponseEnvelopeJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelope) UnmarshalJSON ¶
func (r *RequestConstantsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeErrors ¶ added in v4.4.0
type RequestConstantsResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestConstantsResponseEnvelopeErrorsSource `json:"source"`
JSON requestConstantsResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestConstantsResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestConstantsResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestConstantsResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestConstantsResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeMessages ¶ added in v4.4.0
type RequestConstantsResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestConstantsResponseEnvelopeMessagesSource `json:"source"`
JSON requestConstantsResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestConstantsResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestConstantsResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestConstantsResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestConstantsResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeSuccess ¶
type RequestConstantsResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestConstantsResponseEnvelopeSuccessTrue RequestConstantsResponseEnvelopeSuccess = true
)
func (RequestConstantsResponseEnvelopeSuccess) IsKnown ¶
func (r RequestConstantsResponseEnvelopeSuccess) IsKnown() bool
type RequestConstantsStatus ¶
type RequestConstantsStatus string
Request Status.
const ( RequestConstantsStatusOpen RequestConstantsStatus = "open" RequestConstantsStatusAccepted RequestConstantsStatus = "accepted" RequestConstantsStatusReported RequestConstantsStatus = "reported" RequestConstantsStatusApproved RequestConstantsStatus = "approved" RequestConstantsStatusCompleted RequestConstantsStatus = "completed" RequestConstantsStatusDeclined RequestConstantsStatus = "declined" )
func (RequestConstantsStatus) IsKnown ¶
func (r RequestConstantsStatus) IsKnown() bool
type RequestConstantsTLP ¶
type RequestConstantsTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( RequestConstantsTLPClear RequestConstantsTLP = "clear" RequestConstantsTLPAmber RequestConstantsTLP = "amber" RequestConstantsTLPAmberStrict RequestConstantsTLP = "amber-strict" RequestConstantsTLPGreen RequestConstantsTLP = "green" RequestConstantsTLPRed RequestConstantsTLP = "red" )
func (RequestConstantsTLP) IsKnown ¶
func (r RequestConstantsTLP) IsKnown() bool
type RequestDeleteParams ¶ added in v4.4.0
type RequestDeleteResponse ¶
type RequestDeleteResponse struct {
Errors []RequestDeleteResponseError `json:"errors,required"`
Messages []RequestDeleteResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success RequestDeleteResponseSuccess `json:"success,required"`
JSON requestDeleteResponseJSON `json:"-"`
}
func (*RequestDeleteResponse) UnmarshalJSON ¶
func (r *RequestDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseError ¶ added in v4.4.0
type RequestDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestDeleteResponseErrorsSource `json:"source"`
JSON requestDeleteResponseErrorJSON `json:"-"`
}
func (*RequestDeleteResponseError) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseErrorsSource ¶ added in v4.4.0
type RequestDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseMessage ¶ added in v4.4.0
type RequestDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestDeleteResponseMessagesSource `json:"source"`
JSON requestDeleteResponseMessageJSON `json:"-"`
}
func (*RequestDeleteResponseMessage) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseMessagesSource ¶ added in v4.4.0
type RequestDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestDeleteResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseSuccess ¶
type RequestDeleteResponseSuccess bool
Whether the API call was successful.
const (
RequestDeleteResponseSuccessTrue RequestDeleteResponseSuccess = true
)
func (RequestDeleteResponseSuccess) IsKnown ¶
func (r RequestDeleteResponseSuccess) IsKnown() bool
type RequestGetParams ¶ added in v4.4.0
type RequestGetResponseEnvelope ¶
type RequestGetResponseEnvelope struct {
Errors []RequestGetResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestGetResponseEnvelopeSuccess `json:"success,required"`
Result Item `json:"result"`
JSON requestGetResponseEnvelopeJSON `json:"-"`
}
func (*RequestGetResponseEnvelope) UnmarshalJSON ¶
func (r *RequestGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeErrors ¶ added in v4.4.0
type RequestGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestGetResponseEnvelopeErrorsSource `json:"source"`
JSON requestGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeMessages ¶ added in v4.4.0
type RequestGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestGetResponseEnvelopeMessagesSource `json:"source"`
JSON requestGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeSuccess ¶
type RequestGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestGetResponseEnvelopeSuccessTrue RequestGetResponseEnvelopeSuccess = true
)
func (RequestGetResponseEnvelopeSuccess) IsKnown ¶
func (r RequestGetResponseEnvelopeSuccess) IsKnown() bool
type RequestListParams ¶
type RequestListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Page number of results.
Page param.Field[int64] `json:"page,required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page,required"`
// Retrieve requests completed after this time.
CompletedAfter param.Field[time.Time] `json:"completed_after" format:"date-time"`
// Retrieve requests completed before this time.
CompletedBefore param.Field[time.Time] `json:"completed_before" format:"date-time"`
// Retrieve requests created after this time.
CreatedAfter param.Field[time.Time] `json:"created_after" format:"date-time"`
// Retrieve requests created before this time.
CreatedBefore param.Field[time.Time] `json:"created_before" format:"date-time"`
// Requested information from request.
RequestType param.Field[string] `json:"request_type"`
// Field to sort results by.
SortBy param.Field[string] `json:"sort_by"`
// Sort order (asc or desc).
SortOrder param.Field[RequestListParamsSortOrder] `json:"sort_order"`
// Request Status.
Status param.Field[RequestListParamsStatus] `json:"status"`
}
func (RequestListParams) MarshalJSON ¶
func (r RequestListParams) MarshalJSON() (data []byte, err error)
type RequestListParamsSortOrder ¶
type RequestListParamsSortOrder string
Sort order (asc or desc).
const ( RequestListParamsSortOrderAsc RequestListParamsSortOrder = "asc" RequestListParamsSortOrderDesc RequestListParamsSortOrder = "desc" )
func (RequestListParamsSortOrder) IsKnown ¶
func (r RequestListParamsSortOrder) IsKnown() bool
type RequestListParamsStatus ¶
type RequestListParamsStatus string
Request Status.
const ( RequestListParamsStatusOpen RequestListParamsStatus = "open" RequestListParamsStatusAccepted RequestListParamsStatus = "accepted" RequestListParamsStatusReported RequestListParamsStatus = "reported" RequestListParamsStatusApproved RequestListParamsStatus = "approved" RequestListParamsStatusCompleted RequestListParamsStatus = "completed" RequestListParamsStatusDeclined RequestListParamsStatus = "declined" )
func (RequestListParamsStatus) IsKnown ¶
func (r RequestListParamsStatus) IsKnown() bool
type RequestMessageDeleteParams ¶ added in v4.4.0
type RequestMessageDeleteResponse ¶
type RequestMessageDeleteResponse struct {
Errors []RequestMessageDeleteResponseError `json:"errors,required"`
Messages []RequestMessageDeleteResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success RequestMessageDeleteResponseSuccess `json:"success,required"`
JSON requestMessageDeleteResponseJSON `json:"-"`
}
func (*RequestMessageDeleteResponse) UnmarshalJSON ¶
func (r *RequestMessageDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseError ¶ added in v4.4.0
type RequestMessageDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageDeleteResponseErrorsSource `json:"source"`
JSON requestMessageDeleteResponseErrorJSON `json:"-"`
}
func (*RequestMessageDeleteResponseError) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseErrorsSource ¶ added in v4.4.0
type RequestMessageDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestMessageDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseMessage ¶ added in v4.4.0
type RequestMessageDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageDeleteResponseMessagesSource `json:"source"`
JSON requestMessageDeleteResponseMessageJSON `json:"-"`
}
func (*RequestMessageDeleteResponseMessage) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseMessagesSource ¶ added in v4.4.0
type RequestMessageDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestMessageDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageDeleteResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseSuccess ¶
type RequestMessageDeleteResponseSuccess bool
Whether the API call was successful.
const (
RequestMessageDeleteResponseSuccessTrue RequestMessageDeleteResponseSuccess = true
)
func (RequestMessageDeleteResponseSuccess) IsKnown ¶
func (r RequestMessageDeleteResponseSuccess) IsKnown() bool
type RequestMessageGetParams ¶
type RequestMessageGetParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Page number of results.
Page param.Field[int64] `json:"page,required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page,required"`
// Retrieve mes ges created after this time.
After param.Field[time.Time] `json:"after" format:"date-time"`
// Retrieve messages created before this time.
Before param.Field[time.Time] `json:"before" format:"date-time"`
// Field to sort results by.
SortBy param.Field[string] `json:"sort_by"`
// Sort order (asc or desc).
SortOrder param.Field[RequestMessageGetParamsSortOrder] `json:"sort_order"`
}
func (RequestMessageGetParams) MarshalJSON ¶
func (r RequestMessageGetParams) MarshalJSON() (data []byte, err error)
type RequestMessageGetParamsSortOrder ¶
type RequestMessageGetParamsSortOrder string
Sort order (asc or desc).
const ( RequestMessageGetParamsSortOrderAsc RequestMessageGetParamsSortOrder = "asc" RequestMessageGetParamsSortOrderDesc RequestMessageGetParamsSortOrder = "desc" )
func (RequestMessageGetParamsSortOrder) IsKnown ¶
func (r RequestMessageGetParamsSortOrder) IsKnown() bool
type RequestMessageNewParams ¶
type RequestMessageNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Content of message.
Content param.Field[string] `json:"content"`
}
func (RequestMessageNewParams) MarshalJSON ¶
func (r RequestMessageNewParams) MarshalJSON() (data []byte, err error)
type RequestMessageNewResponseEnvelope ¶
type RequestMessageNewResponseEnvelope struct {
Errors []RequestMessageNewResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestMessageNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestMessageNewResponseEnvelopeSuccess `json:"success,required"`
Result Message `json:"result"`
JSON requestMessageNewResponseEnvelopeJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelope) UnmarshalJSON ¶
func (r *RequestMessageNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeErrors ¶ added in v4.4.0
type RequestMessageNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageNewResponseEnvelopeErrorsSource `json:"source"`
JSON requestMessageNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestMessageNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeMessages ¶ added in v4.4.0
type RequestMessageNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageNewResponseEnvelopeMessagesSource `json:"source"`
JSON requestMessageNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestMessageNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeSuccess ¶
type RequestMessageNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestMessageNewResponseEnvelopeSuccessTrue RequestMessageNewResponseEnvelopeSuccess = true
)
func (RequestMessageNewResponseEnvelopeSuccess) IsKnown ¶
func (r RequestMessageNewResponseEnvelopeSuccess) IsKnown() bool
type RequestMessageService ¶
type RequestMessageService struct {
Options []option.RequestOption
}
RequestMessageService 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 NewRequestMessageService method instead.
func NewRequestMessageService ¶
func NewRequestMessageService(opts ...option.RequestOption) (r *RequestMessageService)
NewRequestMessageService 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 (*RequestMessageService) Delete ¶
func (r *RequestMessageService) Delete(ctx context.Context, requestID string, messageID int64, body RequestMessageDeleteParams, opts ...option.RequestOption) (res *RequestMessageDeleteResponse, err error)
Delete a Request Message
func (*RequestMessageService) Get ¶
func (r *RequestMessageService) Get(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[Message], err error)
List Request Messages
func (*RequestMessageService) GetAutoPaging ¶ added in v4.1.0
func (r *RequestMessageService) GetAutoPaging(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Message]
List Request Messages
func (*RequestMessageService) New ¶
func (r *RequestMessageService) New(ctx context.Context, requestID string, params RequestMessageNewParams, opts ...option.RequestOption) (res *Message, err error)
Create a New Request Message
func (*RequestMessageService) Update ¶
func (r *RequestMessageService) Update(ctx context.Context, requestID string, messageID int64, params RequestMessageUpdateParams, opts ...option.RequestOption) (res *Message, err error)
Update a Request Message
type RequestMessageUpdateParams ¶
type RequestMessageUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Content of message.
Content param.Field[string] `json:"content"`
}
func (RequestMessageUpdateParams) MarshalJSON ¶
func (r RequestMessageUpdateParams) MarshalJSON() (data []byte, err error)
type RequestMessageUpdateResponseEnvelope ¶
type RequestMessageUpdateResponseEnvelope struct {
Errors []RequestMessageUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestMessageUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestMessageUpdateResponseEnvelopeSuccess `json:"success,required"`
Result Message `json:"result"`
JSON requestMessageUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RequestMessageUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeErrors ¶ added in v4.4.0
type RequestMessageUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON requestMessageUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestMessageUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeMessages ¶ added in v4.4.0
type RequestMessageUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestMessageUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON requestMessageUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestMessageUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestMessageUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeSuccess ¶
type RequestMessageUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestMessageUpdateResponseEnvelopeSuccessTrue RequestMessageUpdateResponseEnvelopeSuccess = true
)
func (RequestMessageUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RequestMessageUpdateResponseEnvelopeSuccess) IsKnown() bool
type RequestNewParams ¶
type RequestNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Request content.
Content param.Field[string] `json:"content"`
// Priority for analyzing the request.
Priority param.Field[string] `json:"priority"`
// Requested information from request.
RequestType param.Field[string] `json:"request_type"`
// Brief description of the request.
Summary param.Field[string] `json:"summary"`
// The CISA defined Traffic Light Protocol (TLP).
TLP param.Field[RequestNewParamsTLP] `json:"tlp"`
}
func (RequestNewParams) MarshalJSON ¶
func (r RequestNewParams) MarshalJSON() (data []byte, err error)
type RequestNewParamsTLP ¶
type RequestNewParamsTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( RequestNewParamsTLPClear RequestNewParamsTLP = "clear" RequestNewParamsTLPAmber RequestNewParamsTLP = "amber" RequestNewParamsTLPAmberStrict RequestNewParamsTLP = "amber-strict" RequestNewParamsTLPGreen RequestNewParamsTLP = "green" RequestNewParamsTLPRed RequestNewParamsTLP = "red" )
func (RequestNewParamsTLP) IsKnown ¶
func (r RequestNewParamsTLP) IsKnown() bool
type RequestNewResponseEnvelope ¶
type RequestNewResponseEnvelope struct {
Errors []RequestNewResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestNewResponseEnvelopeSuccess `json:"success,required"`
Result Item `json:"result"`
JSON requestNewResponseEnvelopeJSON `json:"-"`
}
func (*RequestNewResponseEnvelope) UnmarshalJSON ¶
func (r *RequestNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeErrors ¶ added in v4.4.0
type RequestNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestNewResponseEnvelopeErrorsSource `json:"source"`
JSON requestNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeMessages ¶ added in v4.4.0
type RequestNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestNewResponseEnvelopeMessagesSource `json:"source"`
JSON requestNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeSuccess ¶
type RequestNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestNewResponseEnvelopeSuccessTrue RequestNewResponseEnvelopeSuccess = true
)
func (RequestNewResponseEnvelopeSuccess) IsKnown ¶
func (r RequestNewResponseEnvelopeSuccess) IsKnown() bool
type RequestPriorityDeleteParams ¶ added in v4.4.0
type RequestPriorityDeleteResponse ¶
type RequestPriorityDeleteResponse struct {
Errors []RequestPriorityDeleteResponseError `json:"errors,required"`
Messages []RequestPriorityDeleteResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success RequestPriorityDeleteResponseSuccess `json:"success,required"`
JSON requestPriorityDeleteResponseJSON `json:"-"`
}
func (*RequestPriorityDeleteResponse) UnmarshalJSON ¶
func (r *RequestPriorityDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseError ¶ added in v4.4.0
type RequestPriorityDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityDeleteResponseErrorsSource `json:"source"`
JSON requestPriorityDeleteResponseErrorJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseError) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseErrorsSource ¶ added in v4.4.0
type RequestPriorityDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseMessage ¶ added in v4.4.0
type RequestPriorityDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityDeleteResponseMessagesSource `json:"source"`
JSON requestPriorityDeleteResponseMessageJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseMessage) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseMessagesSource ¶ added in v4.4.0
type RequestPriorityDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityDeleteResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseSuccess ¶
type RequestPriorityDeleteResponseSuccess bool
Whether the API call was successful.
const (
RequestPriorityDeleteResponseSuccessTrue RequestPriorityDeleteResponseSuccess = true
)
func (RequestPriorityDeleteResponseSuccess) IsKnown ¶
func (r RequestPriorityDeleteResponseSuccess) IsKnown() bool
type RequestPriorityGetParams ¶ added in v4.4.0
type RequestPriorityGetResponseEnvelope ¶
type RequestPriorityGetResponseEnvelope struct {
Errors []RequestPriorityGetResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestPriorityGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestPriorityGetResponseEnvelopeSuccess `json:"success,required"`
Result Item `json:"result"`
JSON requestPriorityGetResponseEnvelopeJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelope) UnmarshalJSON ¶
func (r *RequestPriorityGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeErrors ¶ added in v4.4.0
type RequestPriorityGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityGetResponseEnvelopeErrorsSource `json:"source"`
JSON requestPriorityGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestPriorityGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeMessages ¶ added in v4.4.0
type RequestPriorityGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityGetResponseEnvelopeMessagesSource `json:"source"`
JSON requestPriorityGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestPriorityGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeSuccess ¶
type RequestPriorityGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestPriorityGetResponseEnvelopeSuccessTrue RequestPriorityGetResponseEnvelopeSuccess = true
)
func (RequestPriorityGetResponseEnvelopeSuccess) IsKnown ¶
func (r RequestPriorityGetResponseEnvelopeSuccess) IsKnown() bool
type RequestPriorityNewParams ¶
type RequestPriorityNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
PriorityEdit PriorityEditParam `json:"priority_edit,required"`
}
func (RequestPriorityNewParams) MarshalJSON ¶
func (r RequestPriorityNewParams) MarshalJSON() (data []byte, err error)
type RequestPriorityNewResponseEnvelope ¶
type RequestPriorityNewResponseEnvelope struct {
Errors []RequestPriorityNewResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestPriorityNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestPriorityNewResponseEnvelopeSuccess `json:"success,required"`
Result Priority `json:"result"`
JSON requestPriorityNewResponseEnvelopeJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelope) UnmarshalJSON ¶
func (r *RequestPriorityNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeErrors ¶ added in v4.4.0
type RequestPriorityNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityNewResponseEnvelopeErrorsSource `json:"source"`
JSON requestPriorityNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestPriorityNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeMessages ¶ added in v4.4.0
type RequestPriorityNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityNewResponseEnvelopeMessagesSource `json:"source"`
JSON requestPriorityNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestPriorityNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeSuccess ¶
type RequestPriorityNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestPriorityNewResponseEnvelopeSuccessTrue RequestPriorityNewResponseEnvelopeSuccess = true
)
func (RequestPriorityNewResponseEnvelopeSuccess) IsKnown ¶
func (r RequestPriorityNewResponseEnvelopeSuccess) IsKnown() bool
type RequestPriorityQuotaParams ¶ added in v4.4.0
type RequestPriorityQuotaResponseEnvelope ¶
type RequestPriorityQuotaResponseEnvelope struct {
Errors []RequestPriorityQuotaResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestPriorityQuotaResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestPriorityQuotaResponseEnvelopeSuccess `json:"success,required"`
Result Quota `json:"result"`
JSON requestPriorityQuotaResponseEnvelopeJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelope) UnmarshalJSON ¶
func (r *RequestPriorityQuotaResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeErrors ¶ added in v4.4.0
type RequestPriorityQuotaResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityQuotaResponseEnvelopeErrorsSource `json:"source"`
JSON requestPriorityQuotaResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityQuotaResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestPriorityQuotaResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityQuotaResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeMessages ¶ added in v4.4.0
type RequestPriorityQuotaResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityQuotaResponseEnvelopeMessagesSource `json:"source"`
JSON requestPriorityQuotaResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityQuotaResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestPriorityQuotaResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityQuotaResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeSuccess ¶
type RequestPriorityQuotaResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestPriorityQuotaResponseEnvelopeSuccessTrue RequestPriorityQuotaResponseEnvelopeSuccess = true
)
func (RequestPriorityQuotaResponseEnvelopeSuccess) IsKnown ¶
func (r RequestPriorityQuotaResponseEnvelopeSuccess) IsKnown() bool
type RequestPriorityService ¶
type RequestPriorityService struct {
Options []option.RequestOption
}
RequestPriorityService 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 NewRequestPriorityService method instead.
func NewRequestPriorityService ¶
func NewRequestPriorityService(opts ...option.RequestOption) (r *RequestPriorityService)
NewRequestPriorityService 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 (*RequestPriorityService) Delete ¶
func (r *RequestPriorityService) Delete(ctx context.Context, priorityID string, body RequestPriorityDeleteParams, opts ...option.RequestOption) (res *RequestPriorityDeleteResponse, err error)
Delete a Priority Intelligence Requirement
func (*RequestPriorityService) Get ¶
func (r *RequestPriorityService) Get(ctx context.Context, priorityID string, query RequestPriorityGetParams, opts ...option.RequestOption) (res *Item, err error)
Get a Priority Intelligence Requirement
func (*RequestPriorityService) New ¶
func (r *RequestPriorityService) New(ctx context.Context, params RequestPriorityNewParams, opts ...option.RequestOption) (res *Priority, err error)
Create a New Priority Intelligence Requirement
func (*RequestPriorityService) Quota ¶
func (r *RequestPriorityService) Quota(ctx context.Context, query RequestPriorityQuotaParams, opts ...option.RequestOption) (res *Quota, err error)
Get Priority Intelligence Requirement Quota
func (*RequestPriorityService) Update ¶
func (r *RequestPriorityService) Update(ctx context.Context, priorityID string, params RequestPriorityUpdateParams, opts ...option.RequestOption) (res *Item, err error)
Update a Priority Intelligence Requirement
type RequestPriorityUpdateParams ¶
type RequestPriorityUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
PriorityEdit PriorityEditParam `json:"priority_edit,required"`
}
func (RequestPriorityUpdateParams) MarshalJSON ¶
func (r RequestPriorityUpdateParams) MarshalJSON() (data []byte, err error)
type RequestPriorityUpdateResponseEnvelope ¶
type RequestPriorityUpdateResponseEnvelope struct {
Errors []RequestPriorityUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestPriorityUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestPriorityUpdateResponseEnvelopeSuccess `json:"success,required"`
Result Item `json:"result"`
JSON requestPriorityUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RequestPriorityUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeErrors ¶ added in v4.4.0
type RequestPriorityUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON requestPriorityUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestPriorityUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeMessages ¶ added in v4.4.0
type RequestPriorityUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestPriorityUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON requestPriorityUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestPriorityUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestPriorityUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeSuccess ¶
type RequestPriorityUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestPriorityUpdateResponseEnvelopeSuccessTrue RequestPriorityUpdateResponseEnvelopeSuccess = true
)
func (RequestPriorityUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RequestPriorityUpdateResponseEnvelopeSuccess) IsKnown() bool
type RequestQuotaParams ¶ added in v4.4.0
type RequestQuotaResponseEnvelope ¶
type RequestQuotaResponseEnvelope struct {
Errors []RequestQuotaResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestQuotaResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestQuotaResponseEnvelopeSuccess `json:"success,required"`
Result Quota `json:"result"`
JSON requestQuotaResponseEnvelopeJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelope) UnmarshalJSON ¶
func (r *RequestQuotaResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeErrors ¶ added in v4.4.0
type RequestQuotaResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestQuotaResponseEnvelopeErrorsSource `json:"source"`
JSON requestQuotaResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestQuotaResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestQuotaResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestQuotaResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeMessages ¶ added in v4.4.0
type RequestQuotaResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestQuotaResponseEnvelopeMessagesSource `json:"source"`
JSON requestQuotaResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestQuotaResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestQuotaResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestQuotaResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeSuccess ¶
type RequestQuotaResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestQuotaResponseEnvelopeSuccessTrue RequestQuotaResponseEnvelopeSuccess = true
)
func (RequestQuotaResponseEnvelopeSuccess) IsKnown ¶
func (r RequestQuotaResponseEnvelopeSuccess) IsKnown() bool
type RequestService ¶
type RequestService struct {
Options []option.RequestOption
Message *RequestMessageService
Priority *RequestPriorityService
Assets *RequestAssetService
}
RequestService 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 NewRequestService method instead.
func NewRequestService ¶
func NewRequestService(opts ...option.RequestOption) (r *RequestService)
NewRequestService 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 (*RequestService) Constants ¶
func (r *RequestService) Constants(ctx context.Context, query RequestConstantsParams, opts ...option.RequestOption) (res *RequestConstants, err error)
Get Request Priority, Status, and TLP constants
func (*RequestService) Delete ¶
func (r *RequestService) Delete(ctx context.Context, requestID string, body RequestDeleteParams, opts ...option.RequestOption) (res *RequestDeleteResponse, err error)
Delete a Request
func (*RequestService) Get ¶
func (r *RequestService) Get(ctx context.Context, requestID string, query RequestGetParams, opts ...option.RequestOption) (res *Item, err error)
Get a Request
func (*RequestService) List ¶
func (r *RequestService) List(ctx context.Context, params RequestListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ListItem], err error)
List Requests
func (*RequestService) ListAutoPaging ¶
func (r *RequestService) ListAutoPaging(ctx context.Context, params RequestListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ListItem]
List Requests
func (*RequestService) New ¶
func (r *RequestService) New(ctx context.Context, params RequestNewParams, opts ...option.RequestOption) (res *Item, err error)
Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.
func (*RequestService) Quota ¶
func (r *RequestService) Quota(ctx context.Context, query RequestQuotaParams, opts ...option.RequestOption) (res *Quota, err error)
Get Request Quota
func (*RequestService) Types ¶
func (r *RequestService) Types(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)
Get Request Types
func (*RequestService) TypesAutoPaging ¶ added in v4.1.0
func (r *RequestService) TypesAutoPaging(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]
Get Request Types
func (*RequestService) Update ¶
func (r *RequestService) Update(ctx context.Context, requestID string, params RequestUpdateParams, opts ...option.RequestOption) (res *Item, err error)
Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.
type RequestTypes ¶
type RequestTypes []string
type RequestTypesParams ¶ added in v4.4.0
type RequestUpdateParams ¶
type RequestUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Request content.
Content param.Field[string] `json:"content"`
// Priority for analyzing the request.
Priority param.Field[string] `json:"priority"`
// Requested information from request.
RequestType param.Field[string] `json:"request_type"`
// Brief description of the request.
Summary param.Field[string] `json:"summary"`
// The CISA defined Traffic Light Protocol (TLP).
TLP param.Field[RequestUpdateParamsTLP] `json:"tlp"`
}
func (RequestUpdateParams) MarshalJSON ¶
func (r RequestUpdateParams) MarshalJSON() (data []byte, err error)
type RequestUpdateParamsTLP ¶
type RequestUpdateParamsTLP string
The CISA defined Traffic Light Protocol (TLP).
const ( RequestUpdateParamsTLPClear RequestUpdateParamsTLP = "clear" RequestUpdateParamsTLPAmber RequestUpdateParamsTLP = "amber" RequestUpdateParamsTLPAmberStrict RequestUpdateParamsTLP = "amber-strict" RequestUpdateParamsTLPGreen RequestUpdateParamsTLP = "green" RequestUpdateParamsTLPRed RequestUpdateParamsTLP = "red" )
func (RequestUpdateParamsTLP) IsKnown ¶
func (r RequestUpdateParamsTLP) IsKnown() bool
type RequestUpdateResponseEnvelope ¶
type RequestUpdateResponseEnvelope struct {
Errors []RequestUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []RequestUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success RequestUpdateResponseEnvelopeSuccess `json:"success,required"`
Result Item `json:"result"`
JSON requestUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RequestUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeErrors ¶ added in v4.4.0
type RequestUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON requestUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeErrorsSource ¶ added in v4.4.0
type RequestUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeMessages ¶ added in v4.4.0
type RequestUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RequestUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON requestUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeMessagesSource ¶ added in v4.4.0
type RequestUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.4.0
func (r *RequestUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeSuccess ¶
type RequestUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
RequestUpdateResponseEnvelopeSuccessTrue RequestUpdateResponseEnvelopeSuccess = true
)
func (RequestUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RequestUpdateResponseEnvelopeSuccess) IsKnown() bool
type ResponseInfoSource ¶ added in v4.3.0
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 ScanConfigDeleteParams ¶ added in v4.2.0
type ScanConfigDeleteResponse ¶ added in v4.2.0
type ScanConfigDeleteResponse = interface{}
type ScanConfigDeleteResponseEnvelope ¶ added in v4.2.0
type ScanConfigDeleteResponseEnvelope struct {
Errors []string `json:"errors,required"`
Messages []string `json:"messages,required"`
Result ScanConfigDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON scanConfigDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ScanConfigDeleteResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditParams ¶ added in v4.2.0
type ScanConfigEditParams struct {
// Defines the Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency param.Field[float64] `json:"frequency"`
// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
// total IP addresses allowed is 5000.
IPs param.Field[[]string] `json:"ips"`
// Defines a list of ports to scan. Valid values are:"default", "all", or a
// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
// "default" scans the 100 most commonly open ports.
Ports param.Field[[]string] `json:"ports"`
}
func (ScanConfigEditParams) MarshalJSON ¶ added in v4.2.0
func (r ScanConfigEditParams) MarshalJSON() (data []byte, err error)
type ScanConfigEditResponse ¶ added in v4.2.0
type ScanConfigEditResponse struct {
// Defines the Config ID.
ID string `json:"id,required"`
AccountID string `json:"account_id,required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency,required"`
// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
// total IP addresses allowed is 5000.
IPs []string `json:"ips,required"`
// Defines a list of ports to scan. Valid values are:"default", "all", or a
// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
// "default" scans the 100 most commonly open ports.
Ports []string `json:"ports,required"`
JSON scanConfigEditResponseJSON `json:"-"`
}
func (*ScanConfigEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigEditResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelope ¶ added in v4.2.0
type ScanConfigEditResponseEnvelope struct {
Errors []ScanConfigEditResponseEnvelopeErrors `json:"errors,required"`
Messages []ScanConfigEditResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ScanConfigEditResponseEnvelopeSuccess `json:"success,required"`
Result ScanConfigEditResponse `json:"result"`
JSON scanConfigEditResponseEnvelopeJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeErrors ¶ added in v4.3.0
type ScanConfigEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ScanConfigEditResponseEnvelopeErrorsSource `json:"source"`
JSON scanConfigEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ScanConfigEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanConfigEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeMessages ¶ added in v4.3.0
type ScanConfigEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ScanConfigEditResponseEnvelopeMessagesSource `json:"source"`
JSON scanConfigEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ScanConfigEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanConfigEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeSuccess ¶ added in v4.2.0
type ScanConfigEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanConfigEditResponseEnvelopeSuccessTrue ScanConfigEditResponseEnvelopeSuccess = true
)
func (ScanConfigEditResponseEnvelopeSuccess) IsKnown ¶ added in v4.2.0
func (r ScanConfigEditResponseEnvelopeSuccess) IsKnown() bool
type ScanConfigListParams ¶ added in v4.2.0
type ScanConfigListResponse ¶ added in v4.2.0
type ScanConfigListResponse struct {
// Defines the Config ID.
ID string `json:"id,required"`
AccountID string `json:"account_id,required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency,required"`
// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
// total IP addresses allowed is 5000.
IPs []string `json:"ips,required"`
// Defines a list of ports to scan. Valid values are:"default", "all", or a
// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
// "default" scans the 100 most commonly open ports.
Ports []string `json:"ports,required"`
JSON scanConfigListResponseJSON `json:"-"`
}
func (*ScanConfigListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigListResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewParams ¶ added in v4.2.0
type ScanConfigNewParams struct {
// Defines the Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
// total IP addresses allowed is 5000.
IPs param.Field[[]string] `json:"ips,required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency param.Field[float64] `json:"frequency"`
// Defines a list of ports to scan. Valid values are:"default", "all", or a
// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
// "default" scans the 100 most commonly open ports.
Ports param.Field[[]string] `json:"ports"`
}
func (ScanConfigNewParams) MarshalJSON ¶ added in v4.2.0
func (r ScanConfigNewParams) MarshalJSON() (data []byte, err error)
type ScanConfigNewResponse ¶ added in v4.2.0
type ScanConfigNewResponse struct {
// Defines the Config ID.
ID string `json:"id,required"`
AccountID string `json:"account_id,required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency,required"`
// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
// total IP addresses allowed is 5000.
IPs []string `json:"ips,required"`
// Defines a list of ports to scan. Valid values are:"default", "all", or a
// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
// "default" scans the 100 most commonly open ports.
Ports []string `json:"ports,required"`
JSON scanConfigNewResponseJSON `json:"-"`
}
func (*ScanConfigNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigNewResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelope ¶ added in v4.2.0
type ScanConfigNewResponseEnvelope struct {
Errors []ScanConfigNewResponseEnvelopeErrors `json:"errors,required"`
Messages []ScanConfigNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ScanConfigNewResponseEnvelopeSuccess `json:"success,required"`
Result ScanConfigNewResponse `json:"result"`
JSON scanConfigNewResponseEnvelopeJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanConfigNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeErrors ¶ added in v4.3.0
type ScanConfigNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ScanConfigNewResponseEnvelopeErrorsSource `json:"source"`
JSON scanConfigNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ScanConfigNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanConfigNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeMessages ¶ added in v4.3.0
type ScanConfigNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ScanConfigNewResponseEnvelopeMessagesSource `json:"source"`
JSON scanConfigNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ScanConfigNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanConfigNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ScanConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeSuccess ¶ added in v4.2.0
type ScanConfigNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanConfigNewResponseEnvelopeSuccessTrue ScanConfigNewResponseEnvelopeSuccess = true
)
func (ScanConfigNewResponseEnvelopeSuccess) IsKnown ¶ added in v4.2.0
func (r ScanConfigNewResponseEnvelopeSuccess) IsKnown() bool
type ScanConfigService ¶ added in v4.2.0
type ScanConfigService struct {
Options []option.RequestOption
}
ScanConfigService 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 NewScanConfigService method instead.
func NewScanConfigService ¶ added in v4.2.0
func NewScanConfigService(opts ...option.RequestOption) (r *ScanConfigService)
NewScanConfigService 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 (*ScanConfigService) Delete ¶ added in v4.2.0
func (r *ScanConfigService) Delete(ctx context.Context, configID string, body ScanConfigDeleteParams, opts ...option.RequestOption) (res *ScanConfigDeleteResponse, err error)
Delete a Scan Config
func (*ScanConfigService) Edit ¶ added in v4.2.0
func (r *ScanConfigService) Edit(ctx context.Context, configID string, params ScanConfigEditParams, opts ...option.RequestOption) (res *ScanConfigEditResponse, err error)
Update an existing Scan Config
func (*ScanConfigService) List ¶ added in v4.2.0
func (r *ScanConfigService) List(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ScanConfigListResponse], err error)
List Scan Configs
func (*ScanConfigService) ListAutoPaging ¶ added in v4.2.0
func (r *ScanConfigService) ListAutoPaging(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ScanConfigListResponse]
List Scan Configs
func (*ScanConfigService) New ¶ added in v4.2.0
func (r *ScanConfigService) New(ctx context.Context, params ScanConfigNewParams, opts ...option.RequestOption) (res *ScanConfigNewResponse, err error)
Create a new Scan Config
type ScanResult ¶ added in v4.2.0
type ScanResult struct {
Number float64 `json:"number"`
Proto string `json:"proto"`
Status string `json:"status"`
JSON scanResultJSON `json:"-"`
}
func (*ScanResult) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanResult) UnmarshalJSON(data []byte) (err error)
type ScanResultGetParams ¶ added in v4.2.0
type ScanResultGetResponse ¶ added in v4.2.0
type ScanResultGetResponse struct {
OneOneOneOne []ScanResult `json:"1.1.1.1,required"`
JSON scanResultGetResponseJSON `json:"-"`
}
func (*ScanResultGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanResultGetResponse) UnmarshalJSON(data []byte) (err error)
type ScanResultGetResponseEnvelope ¶ added in v4.2.0
type ScanResultGetResponseEnvelope struct {
Errors []string `json:"errors,required"`
Messages []string `json:"messages,required"`
Result ScanResultGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON scanResultGetResponseEnvelopeJSON `json:"-"`
}
func (*ScanResultGetResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ScanResultGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanResultService ¶ added in v4.2.0
type ScanResultService struct {
Options []option.RequestOption
}
ScanResultService 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 NewScanResultService method instead.
func NewScanResultService ¶ added in v4.2.0
func NewScanResultService(opts ...option.RequestOption) (r *ScanResultService)
NewScanResultService 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 (*ScanResultService) Get ¶ added in v4.2.0
func (r *ScanResultService) Get(ctx context.Context, configID string, query ScanResultGetParams, opts ...option.RequestOption) (res *ScanResultGetResponse, err error)
Get the Latest Scan Result
type ScanService ¶ added in v4.2.0
type ScanService struct {
Options []option.RequestOption
Results *ScanResultService
Config *ScanConfigService
}
ScanService 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 NewScanService method instead.
func NewScanService ¶ added in v4.2.0
func NewScanService(opts ...option.RequestOption) (r *ScanService)
NewScanService 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 ThreatEventAttackerListParams ¶ added in v4.2.0
type ThreatEventAttackerListResponse ¶ added in v4.2.0
type ThreatEventAttackerListResponse struct {
Items ThreatEventAttackerListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventAttackerListResponseJSON `json:"-"`
}
func (*ThreatEventAttackerListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventAttackerListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventAttackerListResponseItems ¶ added in v4.2.0
type ThreatEventAttackerListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventAttackerListResponseItemsJSON `json:"-"`
}
func (*ThreatEventAttackerListResponseItems) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventAttackerListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventAttackerService ¶ added in v4.2.0
type ThreatEventAttackerService struct {
Options []option.RequestOption
}
ThreatEventAttackerService 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 NewThreatEventAttackerService method instead.
func NewThreatEventAttackerService ¶ added in v4.2.0
func NewThreatEventAttackerService(opts ...option.RequestOption) (r *ThreatEventAttackerService)
NewThreatEventAttackerService 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 (*ThreatEventAttackerService) List ¶ added in v4.2.0
func (r *ThreatEventAttackerService) List(ctx context.Context, query ThreatEventAttackerListParams, opts ...option.RequestOption) (res *ThreatEventAttackerListResponse, err error)
Lists attackers
type ThreatEventBulkNewParams ¶ added in v4.2.0
type ThreatEventBulkNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Data param.Field[[]ThreatEventBulkNewParamsData] `json:"data,required"`
DatasetID param.Field[string] `json:"datasetId,required"`
}
func (ThreatEventBulkNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventBulkNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsData ¶ added in v4.2.0
type ThreatEventBulkNewParamsData struct {
Category param.Field[string] `json:"category,required"`
Date param.Field[time.Time] `json:"date,required" format:"date-time"`
Event param.Field[string] `json:"event,required"`
IndicatorType param.Field[string] `json:"indicatorType,required"`
Raw param.Field[ThreatEventBulkNewParamsDataRaw] `json:"raw,required"`
TLP param.Field[string] `json:"tlp,required"`
AccountID param.Field[float64] `json:"accountId"`
Attacker param.Field[string] `json:"attacker"`
AttackerCountry param.Field[string] `json:"attackerCountry"`
DatasetID param.Field[string] `json:"datasetId"`
Indicator param.Field[string] `json:"indicator"`
Tags param.Field[[]string] `json:"tags"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
}
func (ThreatEventBulkNewParamsData) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventBulkNewParamsData) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsDataRaw ¶ added in v4.2.0
type ThreatEventBulkNewParamsDataRaw struct {
Data param.Field[map[string]interface{}] `json:"data,required"`
Source param.Field[string] `json:"source"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventBulkNewParamsDataRaw) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventBulkNewParamsDataRaw) MarshalJSON() (data []byte, err error)
type ThreatEventCategoryDeleteParams ¶ added in v4.2.0
type ThreatEventCategoryDeleteResponse ¶ added in v4.2.0
type ThreatEventCategoryDeleteResponse struct {
UUID string `json:"uuid,required"`
JSON threatEventCategoryDeleteResponseJSON `json:"-"`
}
func (*ThreatEventCategoryDeleteResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCategoryDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryEditParams ¶ added in v4.2.0
type ThreatEventCategoryEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
KillChain param.Field[float64] `json:"killChain"`
MitreAttack param.Field[[]string] `json:"mitreAttack"`
Name param.Field[string] `json:"name"`
Shortname param.Field[string] `json:"shortname"`
}
func (ThreatEventCategoryEditParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventCategoryEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventCategoryEditResponse ¶ added in v4.2.0
type ThreatEventCategoryEditResponse struct {
KillChain float64 `json:"killChain,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
MitreAttack []string `json:"mitreAttack"`
Shortname string `json:"shortname"`
JSON threatEventCategoryEditResponseJSON `json:"-"`
}
func (*ThreatEventCategoryEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCategoryEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryGetParams ¶ added in v4.2.0
type ThreatEventCategoryGetResponse ¶ added in v4.2.0
type ThreatEventCategoryGetResponse struct {
KillChain float64 `json:"killChain,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
MitreAttack []string `json:"mitreAttack"`
Shortname string `json:"shortname"`
JSON threatEventCategoryGetResponseJSON `json:"-"`
}
func (*ThreatEventCategoryGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCategoryGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryListParams ¶ added in v4.2.0
type ThreatEventCategoryListResponse ¶ added in v4.2.0
type ThreatEventCategoryListResponse struct {
KillChain float64 `json:"killChain,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
MitreAttack []string `json:"mitreAttack"`
Shortname string `json:"shortname"`
JSON threatEventCategoryListResponseJSON `json:"-"`
}
func (*ThreatEventCategoryListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCategoryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryNewParams ¶ added in v4.2.0
type ThreatEventCategoryNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
KillChain param.Field[float64] `json:"killChain,required"`
Name param.Field[string] `json:"name,required"`
MitreAttack param.Field[[]string] `json:"mitreAttack"`
Shortname param.Field[string] `json:"shortname"`
}
func (ThreatEventCategoryNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventCategoryNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventCategoryNewResponse ¶ added in v4.2.0
type ThreatEventCategoryNewResponse struct {
KillChain float64 `json:"killChain,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
MitreAttack []string `json:"mitreAttack"`
Shortname string `json:"shortname"`
JSON threatEventCategoryNewResponseJSON `json:"-"`
}
func (*ThreatEventCategoryNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCategoryNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryService ¶ added in v4.2.0
type ThreatEventCategoryService struct {
Options []option.RequestOption
}
ThreatEventCategoryService 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 NewThreatEventCategoryService method instead.
func NewThreatEventCategoryService ¶ added in v4.2.0
func NewThreatEventCategoryService(opts ...option.RequestOption) (r *ThreatEventCategoryService)
NewThreatEventCategoryService 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 (*ThreatEventCategoryService) Delete ¶ added in v4.2.0
func (r *ThreatEventCategoryService) Delete(ctx context.Context, categoryID string, body ThreatEventCategoryDeleteParams, opts ...option.RequestOption) (res *ThreatEventCategoryDeleteResponse, err error)
Deletes a category
func (*ThreatEventCategoryService) Edit ¶ added in v4.2.0
func (r *ThreatEventCategoryService) Edit(ctx context.Context, categoryID string, params ThreatEventCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventCategoryEditResponse, err error)
Updates a category
func (*ThreatEventCategoryService) Get ¶ added in v4.2.0
func (r *ThreatEventCategoryService) Get(ctx context.Context, categoryID string, query ThreatEventCategoryGetParams, opts ...option.RequestOption) (res *ThreatEventCategoryGetResponse, err error)
Reads a category
func (*ThreatEventCategoryService) List ¶ added in v4.2.0
func (r *ThreatEventCategoryService) List(ctx context.Context, query ThreatEventCategoryListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryListResponse, err error)
Lists categories
func (*ThreatEventCategoryService) New ¶ added in v4.2.0
func (r *ThreatEventCategoryService) New(ctx context.Context, params ThreatEventCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventCategoryNewResponse, err error)
Creates a new category
type ThreatEventCountryListParams ¶ added in v4.2.0
type ThreatEventCountryListResponse ¶ added in v4.2.0
type ThreatEventCountryListResponse struct {
Result []ThreatEventCountryListResponseResult `json:"result,required"`
Success string `json:"success,required"`
JSON threatEventCountryListResponseJSON `json:"-"`
}
func (*ThreatEventCountryListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCountryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCountryListResponseResult ¶ added in v4.2.0
type ThreatEventCountryListResponseResult struct {
Alpha3 string `json:"alpha3,required"`
Name string `json:"name,required"`
JSON threatEventCountryListResponseResultJSON `json:"-"`
}
func (*ThreatEventCountryListResponseResult) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCountryListResponseResult) UnmarshalJSON(data []byte) (err error)
type ThreatEventCountryService ¶ added in v4.2.0
type ThreatEventCountryService struct {
Options []option.RequestOption
}
ThreatEventCountryService 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 NewThreatEventCountryService method instead.
func NewThreatEventCountryService ¶ added in v4.2.0
func NewThreatEventCountryService(opts ...option.RequestOption) (r *ThreatEventCountryService)
NewThreatEventCountryService 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 (*ThreatEventCountryService) List ¶ added in v4.2.0
func (r *ThreatEventCountryService) List(ctx context.Context, query ThreatEventCountryListParams, opts ...option.RequestOption) (res *[]ThreatEventCountryListResponse, err error)
Retrieves countries information for all countries
type ThreatEventCronEditParams ¶ added in v4.2.0
type ThreatEventCronEditResponse ¶ added in v4.2.0
type ThreatEventCronEditResponse struct {
ID float64 `json:"id,required"`
Update string `json:"update,required"`
JSON threatEventCronEditResponseJSON `json:"-"`
}
func (*ThreatEventCronEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCronEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCronListParams ¶ added in v4.2.0
type ThreatEventCronListResponse ¶ added in v4.2.0
type ThreatEventCronListResponse struct {
Update string `json:"update,required"`
JSON threatEventCronListResponseJSON `json:"-"`
}
func (*ThreatEventCronListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventCronListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCronService ¶ added in v4.2.0
type ThreatEventCronService struct {
Options []option.RequestOption
}
ThreatEventCronService 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 NewThreatEventCronService method instead.
func NewThreatEventCronService ¶ added in v4.2.0
func NewThreatEventCronService(opts ...option.RequestOption) (r *ThreatEventCronService)
NewThreatEventCronService 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 (*ThreatEventCronService) Edit ¶ added in v4.2.0
func (r *ThreatEventCronService) Edit(ctx context.Context, body ThreatEventCronEditParams, opts ...option.RequestOption) (res *ThreatEventCronEditResponse, err error)
Reads the last cron update time
func (*ThreatEventCronService) List ¶ added in v4.2.0
func (r *ThreatEventCronService) List(ctx context.Context, query ThreatEventCronListParams, opts ...option.RequestOption) (res *ThreatEventCronListResponse, err error)
Reads the last cron update time
type ThreatEventDatasetEditParams ¶ added in v4.2.0
type ThreatEventDatasetEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// If true, then anyone can search the dataset. If false, then its limited to the
// account.
IsPublic param.Field[bool] `json:"isPublic,required"`
// Used to describe the dataset within the account context.
Name param.Field[string] `json:"name,required"`
}
func (ThreatEventDatasetEditParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventDatasetEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetEditResponse ¶ added in v4.2.0
type ThreatEventDatasetEditResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetEditResponseJSON `json:"-"`
}
func (*ThreatEventDatasetEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDatasetEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetGetParams ¶ added in v4.2.0
type ThreatEventDatasetGetResponse ¶ added in v4.2.0
type ThreatEventDatasetGetResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetGetResponseJSON `json:"-"`
}
func (*ThreatEventDatasetGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDatasetGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetHealthGetParams ¶ added in v4.5.0
type ThreatEventDatasetHealthGetResponse ¶ added in v4.5.0
type ThreatEventDatasetHealthGetResponse struct {
Items ThreatEventDatasetHealthGetResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventDatasetHealthGetResponseJSON `json:"-"`
}
func (*ThreatEventDatasetHealthGetResponse) UnmarshalJSON ¶ added in v4.5.0
func (r *ThreatEventDatasetHealthGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetHealthGetResponseItems ¶ added in v4.5.0
type ThreatEventDatasetHealthGetResponseItems struct {
Type string `json:"type,required"`
JSON threatEventDatasetHealthGetResponseItemsJSON `json:"-"`
}
func (*ThreatEventDatasetHealthGetResponseItems) UnmarshalJSON ¶ added in v4.5.0
func (r *ThreatEventDatasetHealthGetResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetHealthService ¶ added in v4.5.0
type ThreatEventDatasetHealthService struct {
Options []option.RequestOption
}
ThreatEventDatasetHealthService 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 NewThreatEventDatasetHealthService method instead.
func NewThreatEventDatasetHealthService ¶ added in v4.5.0
func NewThreatEventDatasetHealthService(opts ...option.RequestOption) (r *ThreatEventDatasetHealthService)
NewThreatEventDatasetHealthService 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 (*ThreatEventDatasetHealthService) Get ¶ added in v4.5.0
func (r *ThreatEventDatasetHealthService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetHealthGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetHealthGetResponse, err error)
Benchmark Durable Object warmup
type ThreatEventDatasetListParams ¶ added in v4.2.0
type ThreatEventDatasetListResponse ¶ added in v4.2.0
type ThreatEventDatasetListResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventDatasetListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetNewParams ¶ added in v4.2.0
type ThreatEventDatasetNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// If true, then anyone can search the dataset. If false, then its limited to the
// account.
IsPublic param.Field[bool] `json:"isPublic,required"`
// Used to describe the dataset within the account context.
Name param.Field[string] `json:"name,required"`
}
func (ThreatEventDatasetNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventDatasetNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetNewResponse ¶ added in v4.2.0
type ThreatEventDatasetNewResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetNewResponseJSON `json:"-"`
}
func (*ThreatEventDatasetNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDatasetNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetRawParams ¶ added in v4.2.0
type ThreatEventDatasetRawResponse ¶ added in v4.2.0
type ThreatEventDatasetRawResponse struct {
ID string `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Created string `json:"created,required"`
Data interface{} `json:"data,required"`
Source string `json:"source,required"`
TLP string `json:"tlp,required"`
JSON threatEventDatasetRawResponseJSON `json:"-"`
}
func (*ThreatEventDatasetRawResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDatasetRawResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetService ¶ added in v4.2.0
type ThreatEventDatasetService struct {
Options []option.RequestOption
Health *ThreatEventDatasetHealthService
}
ThreatEventDatasetService 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 NewThreatEventDatasetService method instead.
func NewThreatEventDatasetService ¶ added in v4.2.0
func NewThreatEventDatasetService(opts ...option.RequestOption) (r *ThreatEventDatasetService)
NewThreatEventDatasetService 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 (*ThreatEventDatasetService) Edit ¶ added in v4.2.0
func (r *ThreatEventDatasetService) Edit(ctx context.Context, datasetID string, params ThreatEventDatasetEditParams, opts ...option.RequestOption) (res *ThreatEventDatasetEditResponse, err error)
Updates an existing dataset
func (*ThreatEventDatasetService) Get ¶ added in v4.2.0
func (r *ThreatEventDatasetService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetGetResponse, err error)
Reads a dataset
func (*ThreatEventDatasetService) List ¶ added in v4.2.0
func (r *ThreatEventDatasetService) List(ctx context.Context, query ThreatEventDatasetListParams, opts ...option.RequestOption) (res *[]ThreatEventDatasetListResponse, err error)
Lists all datasets in an account
func (*ThreatEventDatasetService) New ¶ added in v4.2.0
func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventDatasetNewParams, opts ...option.RequestOption) (res *ThreatEventDatasetNewResponse, err error)
Creates a dataset
func (*ThreatEventDatasetService) Raw ¶ added in v4.2.0
func (r *ThreatEventDatasetService) Raw(ctx context.Context, datasetID string, eventID string, query ThreatEventDatasetRawParams, opts ...option.RequestOption) (res *ThreatEventDatasetRawResponse, err error)
Reads data for a raw event
type ThreatEventDeleteParams ¶ added in v4.2.0
type ThreatEventDeleteResponse ¶ added in v4.2.0
type ThreatEventDeleteResponse struct {
UUID string `json:"uuid,required"`
JSON threatEventDeleteResponseJSON `json:"-"`
}
func (*ThreatEventDeleteResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEditParams ¶ added in v4.2.0
type ThreatEventEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Attacker param.Field[string] `json:"attacker"`
AttackerCountry param.Field[string] `json:"attackerCountry"`
Category param.Field[string] `json:"category"`
Date param.Field[time.Time] `json:"date" format:"date-time"`
Event param.Field[string] `json:"event"`
Indicator param.Field[string] `json:"indicator"`
IndicatorType param.Field[string] `json:"indicatorType"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventEditParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventEditResponse ¶ added in v4.2.0
type ThreatEventEditResponse struct {
ID float64 `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Attacker string `json:"attacker,required"`
AttackerCountry string `json:"attackerCountry,required"`
Category string `json:"category,required"`
Date string `json:"date,required"`
Event string `json:"event,required"`
Indicator string `json:"indicator,required"`
IndicatorType string `json:"indicatorType,required"`
IndicatorTypeID float64 `json:"indicatorTypeId,required"`
KillChain float64 `json:"killChain,required"`
MitreAttack []string `json:"mitreAttack,required"`
NumReferenced float64 `json:"numReferenced,required"`
NumReferences float64 `json:"numReferences,required"`
RawID string `json:"rawId,required"`
Referenced []string `json:"referenced,required"`
ReferencedIDs []float64 `json:"referencedIds,required"`
References []string `json:"references,required"`
ReferencesIDs []float64 `json:"referencesIds,required"`
Tags []string `json:"tags,required"`
TargetCountry string `json:"targetCountry,required"`
TargetIndustry string `json:"targetIndustry,required"`
TLP string `json:"tlp,required"`
UUID string `json:"uuid,required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventEditResponseJSON `json:"-"`
}
func (*ThreatEventEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagDeleteParams ¶ added in v4.2.0
type ThreatEventEventTagDeleteResponse ¶ added in v4.2.0
type ThreatEventEventTagDeleteResponse struct {
Success bool `json:"success,required"`
JSON threatEventEventTagDeleteResponseJSON `json:"-"`
}
func (*ThreatEventEventTagDeleteResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventEventTagDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagDeleteResponseEnvelope ¶ added in v4.2.0
type ThreatEventEventTagDeleteResponseEnvelope struct {
Result ThreatEventEventTagDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventEventTagDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventEventTagDeleteResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventEventTagDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagNewParams ¶ added in v4.2.0
type ThreatEventEventTagNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Tags param.Field[[]string] `json:"tags,required"`
}
func (ThreatEventEventTagNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventEventTagNewResponse ¶ added in v4.2.0
type ThreatEventEventTagNewResponse struct {
Success bool `json:"success,required"`
JSON threatEventEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventEventTagNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagNewResponseEnvelope ¶ added in v4.2.0
type ThreatEventEventTagNewResponseEnvelope struct {
Result ThreatEventEventTagNewResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventEventTagNewResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventEventTagNewResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventEventTagNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagService ¶ added in v4.2.0
type ThreatEventEventTagService struct {
Options []option.RequestOption
}
ThreatEventEventTagService 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 NewThreatEventEventTagService method instead.
func NewThreatEventEventTagService ¶ added in v4.2.0
func NewThreatEventEventTagService(opts ...option.RequestOption) (r *ThreatEventEventTagService)
NewThreatEventEventTagService 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 (*ThreatEventEventTagService) Delete ¶ added in v4.2.0
func (r *ThreatEventEventTagService) Delete(ctx context.Context, eventID string, body ThreatEventEventTagDeleteParams, opts ...option.RequestOption) (res *ThreatEventEventTagDeleteResponse, err error)
Removes a tag from an event
func (*ThreatEventEventTagService) New ¶ added in v4.2.0
func (r *ThreatEventEventTagService) New(ctx context.Context, eventID string, params ThreatEventEventTagNewParams, opts ...option.RequestOption) (res *ThreatEventEventTagNewResponse, err error)
Adds a tag to an event
type ThreatEventGetParams ¶ added in v4.2.0
type ThreatEventGetResponse ¶ added in v4.2.0
type ThreatEventGetResponse struct {
ID float64 `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Attacker string `json:"attacker,required"`
AttackerCountry string `json:"attackerCountry,required"`
Category string `json:"category,required"`
Date string `json:"date,required"`
Event string `json:"event,required"`
Indicator string `json:"indicator,required"`
IndicatorType string `json:"indicatorType,required"`
IndicatorTypeID float64 `json:"indicatorTypeId,required"`
KillChain float64 `json:"killChain,required"`
MitreAttack []string `json:"mitreAttack,required"`
NumReferenced float64 `json:"numReferenced,required"`
NumReferences float64 `json:"numReferences,required"`
RawID string `json:"rawId,required"`
Referenced []string `json:"referenced,required"`
ReferencedIDs []float64 `json:"referencedIds,required"`
References []string `json:"references,required"`
ReferencesIDs []float64 `json:"referencesIds,required"`
Tags []string `json:"tags,required"`
TargetCountry string `json:"targetCountry,required"`
TargetIndustry string `json:"targetIndustry,required"`
TLP string `json:"tlp,required"`
UUID string `json:"uuid,required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventGetResponseJSON `json:"-"`
}
func (*ThreatEventGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeListParams ¶ added in v4.2.0
type ThreatEventIndicatorTypeListResponse ¶ added in v4.2.0
type ThreatEventIndicatorTypeListResponse struct {
Items ThreatEventIndicatorTypeListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventIndicatorTypeListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorTypeListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventIndicatorTypeListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeListResponseItems ¶ added in v4.2.0
type ThreatEventIndicatorTypeListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventIndicatorTypeListResponseItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorTypeListResponseItems) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventIndicatorTypeListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeService ¶ added in v4.2.0
type ThreatEventIndicatorTypeService struct {
Options []option.RequestOption
}
ThreatEventIndicatorTypeService 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 NewThreatEventIndicatorTypeService method instead.
func NewThreatEventIndicatorTypeService ¶ added in v4.2.0
func NewThreatEventIndicatorTypeService(opts ...option.RequestOption) (r *ThreatEventIndicatorTypeService)
NewThreatEventIndicatorTypeService 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 (*ThreatEventIndicatorTypeService) List ¶ added in v4.2.0
func (r *ThreatEventIndicatorTypeService) List(ctx context.Context, query ThreatEventIndicatorTypeListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorTypeListResponse, err error)
Lists all indicator types
type ThreatEventInsightDeleteParams ¶ added in v4.2.0
type ThreatEventInsightDeleteResponse ¶ added in v4.2.0
type ThreatEventInsightDeleteResponse struct {
Success bool `json:"success,required"`
JSON threatEventInsightDeleteResponseJSON `json:"-"`
}
func (*ThreatEventInsightDeleteResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightDeleteResponseEnvelope ¶ added in v4.2.0
type ThreatEventInsightDeleteResponseEnvelope struct {
Result ThreatEventInsightDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventInsightDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventInsightDeleteResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightEditParams ¶ added in v4.2.0
type ThreatEventInsightEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Content param.Field[string] `json:"content,required"`
}
func (ThreatEventInsightEditParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventInsightEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventInsightEditResponse ¶ added in v4.2.0
type ThreatEventInsightEditResponse struct {
Content string `json:"content,required"`
UUID string `json:"uuid,required"`
JSON threatEventInsightEditResponseJSON `json:"-"`
}
func (*ThreatEventInsightEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightEditResponseEnvelope ¶ added in v4.2.0
type ThreatEventInsightEditResponseEnvelope struct {
Result ThreatEventInsightEditResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventInsightEditResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventInsightEditResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightGetParams ¶ added in v4.2.0
type ThreatEventInsightGetResponse ¶ added in v4.2.0
type ThreatEventInsightGetResponse struct {
Content string `json:"content,required"`
UUID string `json:"uuid,required"`
JSON threatEventInsightGetResponseJSON `json:"-"`
}
func (*ThreatEventInsightGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightGetResponseEnvelope ¶ added in v4.2.0
type ThreatEventInsightGetResponseEnvelope struct {
Result ThreatEventInsightGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventInsightGetResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventInsightGetResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightNewParams ¶ added in v4.2.0
type ThreatEventInsightNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Content param.Field[string] `json:"content,required"`
}
func (ThreatEventInsightNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventInsightNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventInsightNewResponse ¶ added in v4.2.0
type ThreatEventInsightNewResponse struct {
Content string `json:"content,required"`
UUID string `json:"uuid,required"`
JSON threatEventInsightNewResponseJSON `json:"-"`
}
func (*ThreatEventInsightNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightNewResponseEnvelope ¶ added in v4.2.0
type ThreatEventInsightNewResponseEnvelope struct {
Result ThreatEventInsightNewResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventInsightNewResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventInsightNewResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventInsightNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventInsightService ¶ added in v4.2.0
type ThreatEventInsightService struct {
Options []option.RequestOption
}
ThreatEventInsightService 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 NewThreatEventInsightService method instead.
func NewThreatEventInsightService ¶ added in v4.2.0
func NewThreatEventInsightService(opts ...option.RequestOption) (r *ThreatEventInsightService)
NewThreatEventInsightService 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 (*ThreatEventInsightService) Delete ¶ added in v4.2.0
func (r *ThreatEventInsightService) Delete(ctx context.Context, eventID string, insightID string, body ThreatEventInsightDeleteParams, opts ...option.RequestOption) (res *ThreatEventInsightDeleteResponse, err error)
Deletes an event insight
func (*ThreatEventInsightService) Edit ¶ added in v4.2.0
func (r *ThreatEventInsightService) Edit(ctx context.Context, eventID string, insightID string, params ThreatEventInsightEditParams, opts ...option.RequestOption) (res *ThreatEventInsightEditResponse, err error)
Updates an event insight
func (*ThreatEventInsightService) Get ¶ added in v4.2.0
func (r *ThreatEventInsightService) Get(ctx context.Context, eventID string, insightID string, query ThreatEventInsightGetParams, opts ...option.RequestOption) (res *ThreatEventInsightGetResponse, err error)
Reads an event insight
func (*ThreatEventInsightService) New ¶ added in v4.2.0
func (r *ThreatEventInsightService) New(ctx context.Context, eventID string, params ThreatEventInsightNewParams, opts ...option.RequestOption) (res *ThreatEventInsightNewResponse, err error)
Adds an insight to an event
type ThreatEventListParams ¶ added in v4.3.0
type ThreatEventListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
DatasetID param.Field[[]string] `query:"datasetId"`
ForceRefresh param.Field[bool] `query:"forceRefresh"`
Order param.Field[ThreatEventListParamsOrder] `query:"order"`
OrderBy param.Field[string] `query:"orderBy"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
Search param.Field[[]ThreatEventListParamsSearch] `query:"search"`
}
func (ThreatEventListParams) URLQuery ¶ added in v4.3.0
func (r ThreatEventListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventListParams's query parameters as `url.Values`.
type ThreatEventListParamsOrder ¶ added in v4.3.0
type ThreatEventListParamsOrder string
const ( ThreatEventListParamsOrderAsc ThreatEventListParamsOrder = "asc" ThreatEventListParamsOrderDesc ThreatEventListParamsOrder = "desc" )
func (ThreatEventListParamsOrder) IsKnown ¶ added in v4.3.0
func (r ThreatEventListParamsOrder) IsKnown() bool
type ThreatEventListParamsSearch ¶ added in v4.3.0
type ThreatEventListParamsSearch struct {
Field param.Field[string] `query:"field"`
Op param.Field[ThreatEventListParamsSearchOp] `query:"op"`
Value param.Field[ThreatEventListParamsSearchValueUnion] `query:"value"`
}
func (ThreatEventListParamsSearch) URLQuery ¶ added in v4.3.0
func (r ThreatEventListParamsSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventListParamsSearch's query parameters as `url.Values`.
type ThreatEventListParamsSearchOp ¶ added in v4.3.0
type ThreatEventListParamsSearchOp string
const ( ThreatEventListParamsSearchOpEquals ThreatEventListParamsSearchOp = "equals" ThreatEventListParamsSearchOpNot ThreatEventListParamsSearchOp = "not" ThreatEventListParamsSearchOpGt ThreatEventListParamsSearchOp = "gt" ThreatEventListParamsSearchOpGte ThreatEventListParamsSearchOp = "gte" ThreatEventListParamsSearchOpLt ThreatEventListParamsSearchOp = "lt" ThreatEventListParamsSearchOpLte ThreatEventListParamsSearchOp = "lte" ThreatEventListParamsSearchOpLike ThreatEventListParamsSearchOp = "like" ThreatEventListParamsSearchOpContains ThreatEventListParamsSearchOp = "contains" ThreatEventListParamsSearchOpStartsWith ThreatEventListParamsSearchOp = "startsWith" ThreatEventListParamsSearchOpEndsWith ThreatEventListParamsSearchOp = "endsWith" ThreatEventListParamsSearchOpIn ThreatEventListParamsSearchOp = "in" ThreatEventListParamsSearchOpFind ThreatEventListParamsSearchOp = "find" )
func (ThreatEventListParamsSearchOp) IsKnown ¶ added in v4.3.0
func (r ThreatEventListParamsSearchOp) IsKnown() bool
type ThreatEventListParamsSearchValueArray ¶ added in v4.3.0
type ThreatEventListParamsSearchValueArray []ThreatEventListParamsSearchValueArrayItemUnion
func (ThreatEventListParamsSearchValueArray) ImplementsThreatEventListParamsSearchValueUnion ¶ added in v4.3.0
func (r ThreatEventListParamsSearchValueArray) ImplementsThreatEventListParamsSearchValueUnion()
type ThreatEventListParamsSearchValueArrayItemUnion ¶ added in v4.3.0
type ThreatEventListParamsSearchValueArrayItemUnion interface {
ImplementsThreatEventListParamsSearchValueArrayItemUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type ThreatEventListParamsSearchValueUnion ¶ added in v4.3.0
type ThreatEventListParamsSearchValueUnion interface {
ImplementsThreatEventListParamsSearchValueUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventListParamsSearchValueArray.
type ThreatEventListResponse ¶ added in v4.3.0
type ThreatEventListResponse struct {
ID float64 `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Attacker string `json:"attacker,required"`
AttackerCountry string `json:"attackerCountry,required"`
Category string `json:"category,required"`
Date string `json:"date,required"`
Event string `json:"event,required"`
Indicator string `json:"indicator,required"`
IndicatorType string `json:"indicatorType,required"`
IndicatorTypeID float64 `json:"indicatorTypeId,required"`
KillChain float64 `json:"killChain,required"`
MitreAttack []string `json:"mitreAttack,required"`
NumReferenced float64 `json:"numReferenced,required"`
NumReferences float64 `json:"numReferences,required"`
RawID string `json:"rawId,required"`
Referenced []string `json:"referenced,required"`
ReferencedIDs []float64 `json:"referencedIds,required"`
References []string `json:"references,required"`
ReferencesIDs []float64 `json:"referencesIds,required"`
Tags []string `json:"tags,required"`
TargetCountry string `json:"targetCountry,required"`
TargetIndustry string `json:"targetIndustry,required"`
TLP string `json:"tlp,required"`
UUID string `json:"uuid,required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventListResponseJSON `json:"-"`
}
func (*ThreatEventListResponse) UnmarshalJSON ¶ added in v4.3.0
func (r *ThreatEventListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventNewParams ¶ added in v4.2.0
type ThreatEventNewParams struct {
// Account ID.
PathAccountID param.Field[string] `path:"account_id,required"`
Category param.Field[string] `json:"category,required"`
Date param.Field[time.Time] `json:"date,required" format:"date-time"`
Event param.Field[string] `json:"event,required"`
IndicatorType param.Field[string] `json:"indicatorType,required"`
Raw param.Field[ThreatEventNewParamsRaw] `json:"raw,required"`
TLP param.Field[string] `json:"tlp,required"`
BodyAccountID param.Field[float64] `json:"accountId"`
Attacker param.Field[string] `json:"attacker"`
AttackerCountry param.Field[string] `json:"attackerCountry"`
DatasetID param.Field[string] `json:"datasetId"`
Indicator param.Field[string] `json:"indicator"`
Tags param.Field[[]string] `json:"tags"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
}
func (ThreatEventNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventNewParamsRaw ¶ added in v4.2.0
type ThreatEventNewParamsRaw struct {
Data param.Field[map[string]interface{}] `json:"data,required"`
Source param.Field[string] `json:"source"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventNewParamsRaw) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventNewParamsRaw) MarshalJSON() (data []byte, err error)
type ThreatEventNewResponse ¶ added in v4.2.0
type ThreatEventNewResponse struct {
ID float64 `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Attacker string `json:"attacker,required"`
AttackerCountry string `json:"attackerCountry,required"`
Category string `json:"category,required"`
Date string `json:"date,required"`
Event string `json:"event,required"`
Indicator string `json:"indicator,required"`
IndicatorType string `json:"indicatorType,required"`
IndicatorTypeID float64 `json:"indicatorTypeId,required"`
KillChain float64 `json:"killChain,required"`
MitreAttack []string `json:"mitreAttack,required"`
NumReferenced float64 `json:"numReferenced,required"`
NumReferences float64 `json:"numReferences,required"`
RawID string `json:"rawId,required"`
Referenced []string `json:"referenced,required"`
ReferencedIDs []float64 `json:"referencedIds,required"`
References []string `json:"references,required"`
ReferencesIDs []float64 `json:"referencesIds,required"`
Tags []string `json:"tags,required"`
TargetCountry string `json:"targetCountry,required"`
TargetIndustry string `json:"targetIndustry,required"`
TLP string `json:"tlp,required"`
UUID string `json:"uuid,required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventNewResponseJSON `json:"-"`
}
func (*ThreatEventNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawEditParams ¶ added in v4.2.0
type ThreatEventRawEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Data param.Field[interface{}] `json:"data"`
Source param.Field[string] `json:"source"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventRawEditParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventRawEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventRawEditResponse ¶ added in v4.2.0
type ThreatEventRawEditResponse struct {
ID string `json:"id,required"`
Data interface{} `json:"data,required"`
JSON threatEventRawEditResponseJSON `json:"-"`
}
func (*ThreatEventRawEditResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventRawEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawGetParams ¶ added in v4.2.0
type ThreatEventRawGetResponse ¶ added in v4.2.0
type ThreatEventRawGetResponse struct {
ID string `json:"id,required"`
AccountID float64 `json:"accountId,required"`
Created string `json:"created,required"`
Data interface{} `json:"data,required"`
Source string `json:"source,required"`
TLP string `json:"tlp,required"`
JSON threatEventRawGetResponseJSON `json:"-"`
}
func (*ThreatEventRawGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventRawGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawService ¶ added in v4.2.0
type ThreatEventRawService struct {
Options []option.RequestOption
}
ThreatEventRawService 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 NewThreatEventRawService method instead.
func NewThreatEventRawService ¶ added in v4.2.0
func NewThreatEventRawService(opts ...option.RequestOption) (r *ThreatEventRawService)
NewThreatEventRawService 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 (*ThreatEventRawService) Edit ¶ added in v4.2.0
func (r *ThreatEventRawService) Edit(ctx context.Context, eventID string, rawID string, params ThreatEventRawEditParams, opts ...option.RequestOption) (res *ThreatEventRawEditResponse, err error)
Updates a raw event
func (*ThreatEventRawService) Get ¶ added in v4.2.0
func (r *ThreatEventRawService) Get(ctx context.Context, eventID string, rawID string, query ThreatEventRawGetParams, opts ...option.RequestOption) (res *ThreatEventRawGetResponse, err error)
Reads data for a raw event
type ThreatEventRelateDeleteParams ¶ added in v4.2.0
type ThreatEventRelateDeleteResponse ¶ added in v4.2.0
type ThreatEventRelateDeleteResponse struct {
Success bool `json:"success,required"`
JSON threatEventRelateDeleteResponseJSON `json:"-"`
}
func (*ThreatEventRelateDeleteResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventRelateDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelateDeleteResponseEnvelope ¶ added in v4.2.0
type ThreatEventRelateDeleteResponseEnvelope struct {
Result ThreatEventRelateDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventRelateDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventRelateDeleteResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventRelateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelateService ¶ added in v4.2.0
type ThreatEventRelateService struct {
Options []option.RequestOption
}
ThreatEventRelateService 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 NewThreatEventRelateService method instead.
func NewThreatEventRelateService ¶ added in v4.2.0
func NewThreatEventRelateService(opts ...option.RequestOption) (r *ThreatEventRelateService)
NewThreatEventRelateService 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 (*ThreatEventRelateService) Delete ¶ added in v4.2.0
func (r *ThreatEventRelateService) Delete(ctx context.Context, eventID string, body ThreatEventRelateDeleteParams, opts ...option.RequestOption) (res *ThreatEventRelateDeleteResponse, err error)
Removes an event reference
type ThreatEventService ¶ added in v4.2.0
type ThreatEventService struct {
Options []option.RequestOption
Attackers *ThreatEventAttackerService
Categories *ThreatEventCategoryService
Countries *ThreatEventCountryService
Crons *ThreatEventCronService
Datasets *ThreatEventDatasetService
IndicatorTypes *ThreatEventIndicatorTypeService
Raw *ThreatEventRawService
Relate *ThreatEventRelateService
Tags *ThreatEventTagService
EventTags *ThreatEventEventTagService
TargetIndustries *ThreatEventTargetIndustryService
Insights *ThreatEventInsightService
}
ThreatEventService 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 NewThreatEventService method instead.
func NewThreatEventService ¶ added in v4.2.0
func NewThreatEventService(opts ...option.RequestOption) (r *ThreatEventService)
NewThreatEventService 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 (*ThreatEventService) BulkNew ¶ added in v4.2.0
func (r *ThreatEventService) BulkNew(ctx context.Context, params ThreatEventBulkNewParams, opts ...option.RequestOption) (res *float64, err error)
The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.
func (*ThreatEventService) Delete ¶ added in v4.2.0
func (r *ThreatEventService) Delete(ctx context.Context, eventID string, body ThreatEventDeleteParams, opts ...option.RequestOption) (res *ThreatEventDeleteResponse, err error)
The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.
func (*ThreatEventService) Edit ¶ added in v4.2.0
func (r *ThreatEventService) Edit(ctx context.Context, eventID string, params ThreatEventEditParams, opts ...option.RequestOption) (res *ThreatEventEditResponse, err error)
Updates an event
func (*ThreatEventService) Get ¶ added in v4.2.0
func (r *ThreatEventService) Get(ctx context.Context, eventID string, query ThreatEventGetParams, opts ...option.RequestOption) (res *ThreatEventGetResponse, err error)
Reads an event
func (*ThreatEventService) List ¶ added in v4.3.0
func (r *ThreatEventService) List(ctx context.Context, params ThreatEventListParams, opts ...option.RequestOption) (res *[]ThreatEventListResponse, err error)
The `datasetId` must be defined (to list existing datasets (and their IDs), use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint). Also, must provide query parameters.
func (*ThreatEventService) New ¶ added in v4.2.0
func (r *ThreatEventService) New(ctx context.Context, params ThreatEventNewParams, opts ...option.RequestOption) (res *ThreatEventNewResponse, err error)
Events must be created in a client-specific dataset, which means the `datasetId` parameter must be defined. To create a dataset, see the [`Create Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/) endpoint.
type ThreatEventTagNewParams ¶ added in v4.2.0
type ThreatEventTagNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Name param.Field[string] `json:"name,required"`
}
func (ThreatEventTagNewParams) MarshalJSON ¶ added in v4.2.0
func (r ThreatEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewResponse ¶ added in v4.2.0
type ThreatEventTagNewResponse struct {
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventTagNewResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagService ¶ added in v4.2.0
type ThreatEventTagService struct {
Options []option.RequestOption
}
ThreatEventTagService 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 NewThreatEventTagService method instead.
func NewThreatEventTagService ¶ added in v4.2.0
func NewThreatEventTagService(opts ...option.RequestOption) (r *ThreatEventTagService)
NewThreatEventTagService 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 (*ThreatEventTagService) New ¶ added in v4.2.0
func (r *ThreatEventTagService) New(ctx context.Context, params ThreatEventTagNewParams, opts ...option.RequestOption) (res *ThreatEventTagNewResponse, err error)
Creates a new tag
type ThreatEventTargetIndustryListParams ¶ added in v4.2.0
type ThreatEventTargetIndustryListResponse ¶ added in v4.2.0
type ThreatEventTargetIndustryListResponse struct {
Items ThreatEventTargetIndustryListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventTargetIndustryListResponseJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventTargetIndustryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryListResponseItems ¶ added in v4.2.0
type ThreatEventTargetIndustryListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventTargetIndustryListResponseItemsJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponseItems) UnmarshalJSON ¶ added in v4.2.0
func (r *ThreatEventTargetIndustryListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryService ¶ added in v4.2.0
type ThreatEventTargetIndustryService struct {
Options []option.RequestOption
}
ThreatEventTargetIndustryService 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 NewThreatEventTargetIndustryService method instead.
func NewThreatEventTargetIndustryService ¶ added in v4.2.0
func NewThreatEventTargetIndustryService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryService)
NewThreatEventTargetIndustryService 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 (*ThreatEventTargetIndustryService) List ¶ added in v4.2.0
func (r *ThreatEventTargetIndustryService) List(ctx context.Context, query ThreatEventTargetIndustryListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryListResponse, err error)
Lists all target industries
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesMap ¶ added in v4.6.0
type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesMapParam ¶ added in v4.6.0
type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶ added in v4.6.0
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶ added in v4.6.0
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
Source Files
¶
- aliases.go
- cloudforceone.go
- request.go
- requestasset.go
- requestmessage.go
- requestpriority.go
- scan.go
- scanconfig.go
- scanresult.go
- threatevent.go
- threateventattacker.go
- threateventcategory.go
- threateventcountry.go
- threateventcron.go
- threateventdataset.go
- threateventdatasethealth.go
- threateventeventtag.go
- threateventindicatortype.go
- threateventinsight.go
- threateventraw.go
- threateventrelate.go
- threateventtag.go
- threateventtargetindustry.go