Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type BinaryStorageGetParams
- type BinaryStorageNewParams
- type BinaryStorageNewResponse
- type BinaryStorageService
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- 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 ThreatEventBulkNewParamsDataIndicator
- type ThreatEventBulkNewParamsDataRaw
- type ThreatEventBulkNewResponse
- type ThreatEventBulkNewResponseError
- 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, params 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 ThreatEventCronService
- type ThreatEventDatasetEditParams
- type ThreatEventDatasetEditResponse
- type ThreatEventDatasetGetParams
- type ThreatEventDatasetGetResponse
- 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 ThreatEventEditParamsRaw
- 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 ThreatEventInsightService
- type ThreatEventListParams
- type ThreatEventListParamsFormat
- type ThreatEventListParamsOrder
- type ThreatEventListParamsSearch
- type ThreatEventListParamsSearchOp
- type ThreatEventListParamsSearchValueArray
- type ThreatEventListParamsSearchValueArrayItemUnion
- type ThreatEventListParamsSearchValueUnion
- type ThreatEventListResponse
- type ThreatEventNewParams
- type ThreatEventNewParamsIndicator
- 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 *ThreatEventBulkNewResponse, 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)deprecated
- 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 TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type BinaryStorageGetParams ¶
type BinaryStorageNewParams ¶
type BinaryStorageNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// The binary file content to upload.
File param.Field[io.Reader] `json:"file,required" format:"binary"`
}
func (BinaryStorageNewParams) MarshalMultipart ¶
func (r BinaryStorageNewParams) MarshalMultipart() (data []byte, contentType string, err error)
type BinaryStorageNewResponse ¶
type BinaryStorageNewResponse struct {
ContentType string `json:"content_type,required"`
Md5 string `json:"md5,required"`
Sha1 string `json:"sha1,required"`
Sha256 string `json:"sha256,required"`
JSON binaryStorageNewResponseJSON `json:"-"`
}
func (*BinaryStorageNewResponse) UnmarshalJSON ¶
func (r *BinaryStorageNewResponse) UnmarshalJSON(data []byte) (err error)
type BinaryStorageService ¶
type BinaryStorageService struct {
Options []option.RequestOption
}
BinaryStorageService 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 NewBinaryStorageService method instead.
func NewBinaryStorageService ¶
func NewBinaryStorageService(opts ...option.RequestOption) (r *BinaryStorageService)
NewBinaryStorageService 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 (*BinaryStorageService) Get ¶
func (r *BinaryStorageService) Get(ctx context.Context, hash string, query BinaryStorageGetParams, opts ...option.RequestOption) (err error)
Retrieves a file from Binary Storage
func (*BinaryStorageService) New ¶
func (r *BinaryStorageService) New(ctx context.Context, params BinaryStorageNewParams, opts ...option.RequestOption) (res *BinaryStorageNewResponse, err error)
Posts a file to Binary Storage
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type CloudforceOneService ¶
type CloudforceOneService struct {
Options []option.RequestOption
Scans *ScanService
BinaryStorage *BinaryStorageService
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 ¶
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 ¶
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 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 ¶
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 ¶
func (r *RequestAssetDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseErrorsSource ¶
type RequestAssetDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestAssetDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestAssetDeleteResponseErrorsSource) UnmarshalJSON ¶
func (r *RequestAssetDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseMessage ¶
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 ¶
func (r *RequestAssetDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseMessagesSource ¶
type RequestAssetDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestAssetDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestAssetDeleteResponseMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (r *RequestAssetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeErrorsSource ¶
type RequestAssetUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestAssetUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestAssetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeMessages ¶
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 ¶
func (r *RequestAssetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestAssetUpdateResponseEnvelopeMessagesSource ¶
type RequestAssetUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestAssetUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestAssetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
func (r *RequestConstantsResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeErrorsSource ¶
type RequestConstantsResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestConstantsResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestConstantsResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeMessages ¶
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 ¶
func (r *RequestConstantsResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestConstantsResponseEnvelopeMessagesSource ¶
type RequestConstantsResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestConstantsResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestConstantsResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
func (r *RequestDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseErrorsSource ¶
type RequestDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestDeleteResponseErrorsSource) UnmarshalJSON ¶
func (r *RequestDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseMessage ¶
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 ¶
func (r *RequestDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseMessagesSource ¶
type RequestDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestDeleteResponseMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
func (r *RequestGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeErrorsSource ¶
type RequestGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeMessages ¶
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 ¶
func (r *RequestGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestGetResponseEnvelopeMessagesSource ¶
type RequestGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 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 ¶
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 ¶
func (r *RequestMessageDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseErrorsSource ¶
type RequestMessageDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestMessageDeleteResponseErrorsSource) UnmarshalJSON ¶
func (r *RequestMessageDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseMessage ¶
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 ¶
func (r *RequestMessageDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseMessagesSource ¶
type RequestMessageDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestMessageDeleteResponseMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
func (r *RequestMessageNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeErrorsSource ¶
type RequestMessageNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestMessageNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeMessages ¶
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 ¶
func (r *RequestMessageNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestMessageNewResponseEnvelopeMessagesSource ¶
type RequestMessageNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestMessageNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
func (r *RequestMessageUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeErrorsSource ¶
type RequestMessageUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestMessageUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestMessageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeMessages ¶
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 ¶
func (r *RequestMessageUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestMessageUpdateResponseEnvelopeMessagesSource ¶
type RequestMessageUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestMessageUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestMessageUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
func (r *RequestNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeErrorsSource ¶
type RequestNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeMessages ¶
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 ¶
func (r *RequestNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestNewResponseEnvelopeMessagesSource ¶
type RequestNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 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 ¶
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 ¶
func (r *RequestPriorityDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseErrorsSource ¶
type RequestPriorityDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseErrorsSource) UnmarshalJSON ¶
func (r *RequestPriorityDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseMessage ¶
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 ¶
func (r *RequestPriorityDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseMessagesSource ¶
type RequestPriorityDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityDeleteResponseMessagesSource) UnmarshalJSON ¶
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 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 ¶
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 ¶
func (r *RequestPriorityGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeErrorsSource ¶
type RequestPriorityGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestPriorityGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeMessages ¶
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 ¶
func (r *RequestPriorityGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityGetResponseEnvelopeMessagesSource ¶
type RequestPriorityGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
func (r *RequestPriorityNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeErrorsSource ¶
type RequestPriorityNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestPriorityNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeMessages ¶
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 ¶
func (r *RequestPriorityNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityNewResponseEnvelopeMessagesSource ¶
type RequestPriorityNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 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 ¶
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 ¶
func (r *RequestPriorityQuotaResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeErrorsSource ¶
type RequestPriorityQuotaResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestPriorityQuotaResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeMessages ¶
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 ¶
func (r *RequestPriorityQuotaResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityQuotaResponseEnvelopeMessagesSource ¶
type RequestPriorityQuotaResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityQuotaResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
func (r *RequestPriorityUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeErrorsSource ¶
type RequestPriorityUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestPriorityUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeMessages ¶
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 ¶
func (r *RequestPriorityUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestPriorityUpdateResponseEnvelopeMessagesSource ¶
type RequestPriorityUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestPriorityUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestPriorityUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
func (r *RequestQuotaResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeErrorsSource ¶
type RequestQuotaResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestQuotaResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeMessages ¶
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 ¶
func (r *RequestQuotaResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestQuotaResponseEnvelopeMessagesSource ¶
type RequestQuotaResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestQuotaResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (r *RequestUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeErrorsSource ¶
type RequestUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON requestUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *RequestUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeMessages ¶
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 ¶
func (r *RequestUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RequestUpdateResponseEnvelopeMessagesSource ¶
type RequestUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON requestUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RequestUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ¶
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 ¶
type ScanConfigDeleteResponse ¶
type ScanConfigDeleteResponse = interface{}
type ScanConfigDeleteResponseEnvelope ¶
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 ¶
func (r *ScanConfigDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditParams ¶
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 ¶
func (r ScanConfigEditParams) MarshalJSON() (data []byte, err error)
type ScanConfigEditResponse ¶
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 ¶
func (r *ScanConfigEditResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelope ¶
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 ¶
func (r *ScanConfigEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeErrors ¶
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 ¶
func (r *ScanConfigEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeErrorsSource ¶
type ScanConfigEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanConfigEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ScanConfigEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeMessages ¶
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 ¶
func (r *ScanConfigEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeMessagesSource ¶
type ScanConfigEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanConfigEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanConfigEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *ScanConfigEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelopeSuccess ¶
type ScanConfigEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanConfigEditResponseEnvelopeSuccessTrue ScanConfigEditResponseEnvelopeSuccess = true
)
func (ScanConfigEditResponseEnvelopeSuccess) IsKnown ¶
func (r ScanConfigEditResponseEnvelopeSuccess) IsKnown() bool
type ScanConfigListParams ¶
type ScanConfigListResponse ¶
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 ¶
func (r *ScanConfigListResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewParams ¶
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 ¶
func (r ScanConfigNewParams) MarshalJSON() (data []byte, err error)
type ScanConfigNewResponse ¶
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 ¶
func (r *ScanConfigNewResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelope ¶
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 ¶
func (r *ScanConfigNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeErrors ¶
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 ¶
func (r *ScanConfigNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeErrorsSource ¶
type ScanConfigNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON scanConfigNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ScanConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeMessages ¶
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 ¶
func (r *ScanConfigNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeMessagesSource ¶
type ScanConfigNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON scanConfigNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ScanConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *ScanConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelopeSuccess ¶
type ScanConfigNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ScanConfigNewResponseEnvelopeSuccessTrue ScanConfigNewResponseEnvelopeSuccess = true
)
func (ScanConfigNewResponseEnvelopeSuccess) IsKnown ¶
func (r ScanConfigNewResponseEnvelopeSuccess) IsKnown() bool
type ScanConfigService ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (r *ScanConfigService) List(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ScanConfigListResponse], err error)
List Scan Configs
func (*ScanConfigService) ListAutoPaging ¶
func (r *ScanConfigService) ListAutoPaging(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ScanConfigListResponse]
List Scan Configs
func (*ScanConfigService) New ¶
func (r *ScanConfigService) New(ctx context.Context, params ScanConfigNewParams, opts ...option.RequestOption) (res *ScanConfigNewResponse, err error)
Create a new Scan Config
type ScanResult ¶
type ScanResult struct {
Number float64 `json:"number"`
Proto string `json:"proto"`
Status string `json:"status"`
JSON scanResultJSON `json:"-"`
}
func (*ScanResult) UnmarshalJSON ¶
func (r *ScanResult) UnmarshalJSON(data []byte) (err error)
type ScanResultGetParams ¶
type ScanResultGetResponse ¶
type ScanResultGetResponse struct {
OneOneOneOne []ScanResult `json:"1.1.1.1,required"`
JSON scanResultGetResponseJSON `json:"-"`
}
func (*ScanResultGetResponse) UnmarshalJSON ¶
func (r *ScanResultGetResponse) UnmarshalJSON(data []byte) (err error)
type ScanResultGetResponseEnvelope ¶
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 ¶
func (r *ScanResultGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScanResultService ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ThreatEventAttackerListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// Array of dataset IDs to query attackers from. If not provided, uses the default
// dataset.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
}
func (ThreatEventAttackerListParams) URLQuery ¶ added in v6.3.0
func (r ThreatEventAttackerListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventAttackerListParams's query parameters as `url.Values`.
type ThreatEventAttackerListResponse ¶
type ThreatEventAttackerListResponse struct {
Items ThreatEventAttackerListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventAttackerListResponseJSON `json:"-"`
}
func (*ThreatEventAttackerListResponse) UnmarshalJSON ¶
func (r *ThreatEventAttackerListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventAttackerListResponseItems ¶
type ThreatEventAttackerListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventAttackerListResponseItemsJSON `json:"-"`
}
func (*ThreatEventAttackerListResponseItems) UnmarshalJSON ¶
func (r *ThreatEventAttackerListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventAttackerService ¶
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 ¶
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 ¶
func (r *ThreatEventAttackerService) List(ctx context.Context, params ThreatEventAttackerListParams, opts ...option.RequestOption) (res *ThreatEventAttackerListResponse, err error)
Lists attackers across multiple datasets
type ThreatEventBulkNewParams ¶
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"`
// When true, use provided UUIDs from event data instead of generating new ones.
// Used for migration scenarios where original UUIDs must be preserved. Duplicate
// UUIDs will be skipped.
PreserveUUID param.Field[bool] `json:"preserveUuid"`
}
func (ThreatEventBulkNewParams) MarshalJSON ¶
func (r ThreatEventBulkNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsData ¶
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"`
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"`
// Array of indicators for this event. Supports multiple indicators per event for
// complex scenarios.
Indicators param.Field[[]ThreatEventBulkNewParamsDataIndicator] `json:"indicators"`
IndicatorType param.Field[string] `json:"indicatorType"`
Insight param.Field[string] `json:"insight"`
Tags param.Field[[]string] `json:"tags"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
// Optional UUID for the event. Only used when preserveUuid=true in bulk create.
// Must be a valid UUID format.
UUID param.Field[string] `json:"uuid"`
}
func (ThreatEventBulkNewParamsData) MarshalJSON ¶
func (r ThreatEventBulkNewParamsData) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsDataIndicator ¶ added in v6.4.0
type ThreatEventBulkNewParamsDataIndicator struct {
// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
IndicatorType param.Field[string] `json:"indicatorType,required"`
// The indicator value (e.g., domain name, IP address, hash)
Value param.Field[string] `json:"value,required"`
}
func (ThreatEventBulkNewParamsDataIndicator) MarshalJSON ¶ added in v6.4.0
func (r ThreatEventBulkNewParamsDataIndicator) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsDataRaw ¶
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 ¶
func (r ThreatEventBulkNewParamsDataRaw) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewResponse ¶ added in v6.4.0
type ThreatEventBulkNewResponse struct {
// Number of events created
CreatedEventsCount float64 `json:"createdEventsCount,required"`
// Number of new tags created in SoT
CreatedTagsCount float64 `json:"createdTagsCount,required"`
// Number of errors encountered
ErrorCount float64 `json:"errorCount,required"`
// Number of indicators queued for async processing
QueuedIndicatorsCount float64 `json:"queuedIndicatorsCount,required"`
// Number of events skipped due to duplicate UUID (only when preserveUuid=true)
SkippedEventsCount float64 `json:"skippedEventsCount,required"`
// Correlation ID for async indicator processing
CreateBulkEventsRequestID string `json:"createBulkEventsRequestId" format:"uuid"`
// Array of error details
Errors []ThreatEventBulkNewResponseError `json:"errors"`
JSON threatEventBulkNewResponseJSON `json:"-"`
}
Detailed result of bulk event creation with auto-tag management
func (*ThreatEventBulkNewResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ThreatEventBulkNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventBulkNewResponseError ¶ added in v6.4.0
type ThreatEventBulkNewResponseError struct {
// Error message
Error string `json:"error,required"`
// Index of the event that caused the error
EventIndex float64 `json:"eventIndex,required"`
JSON threatEventBulkNewResponseErrorJSON `json:"-"`
}
func (*ThreatEventBulkNewResponseError) UnmarshalJSON ¶ added in v6.4.0
func (r *ThreatEventBulkNewResponseError) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryDeleteResponse ¶
type ThreatEventCategoryDeleteResponse struct {
UUID string `json:"uuid,required"`
JSON threatEventCategoryDeleteResponseJSON `json:"-"`
}
func (*ThreatEventCategoryDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventCategoryDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryEditParams ¶
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 ¶
func (r ThreatEventCategoryEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventCategoryEditResponse ¶
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 ¶
func (r *ThreatEventCategoryEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryGetResponse ¶
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 ¶
func (r *ThreatEventCategoryGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryListParams ¶
type ThreatEventCategoryListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// Array of dataset IDs to query categories from. If not provided, uses the default
// dataset.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
}
func (ThreatEventCategoryListParams) URLQuery ¶ added in v6.3.0
func (r ThreatEventCategoryListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventCategoryListParams's query parameters as `url.Values`.
type ThreatEventCategoryListResponse ¶
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 ¶
func (r *ThreatEventCategoryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryNewParams ¶
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 ¶
func (r ThreatEventCategoryNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventCategoryNewResponse ¶
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 ¶
func (r *ThreatEventCategoryNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryService ¶
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 ¶
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 ¶
func (r *ThreatEventCategoryService) Delete(ctx context.Context, categoryID string, body ThreatEventCategoryDeleteParams, opts ...option.RequestOption) (res *ThreatEventCategoryDeleteResponse, err error)
Deletes a category
func (*ThreatEventCategoryService) Edit ¶
func (r *ThreatEventCategoryService) Edit(ctx context.Context, categoryID string, params ThreatEventCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventCategoryEditResponse, err error)
Updates a category
func (*ThreatEventCategoryService) Get ¶
func (r *ThreatEventCategoryService) Get(ctx context.Context, categoryID string, query ThreatEventCategoryGetParams, opts ...option.RequestOption) (res *ThreatEventCategoryGetResponse, err error)
Reads a category
func (*ThreatEventCategoryService) List ¶
func (r *ThreatEventCategoryService) List(ctx context.Context, params ThreatEventCategoryListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryListResponse, err error)
Lists categories across multiple datasets
func (*ThreatEventCategoryService) New ¶
func (r *ThreatEventCategoryService) New(ctx context.Context, params ThreatEventCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventCategoryNewResponse, err error)
Creates a new category
type ThreatEventCountryListResponse ¶
type ThreatEventCountryListResponse struct {
Result []ThreatEventCountryListResponseResult `json:"result,required"`
Success string `json:"success,required"`
JSON threatEventCountryListResponseJSON `json:"-"`
}
func (*ThreatEventCountryListResponse) UnmarshalJSON ¶
func (r *ThreatEventCountryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCountryListResponseResult ¶
type ThreatEventCountryListResponseResult struct {
Alpha3 string `json:"alpha3,required"`
Name string `json:"name,required"`
JSON threatEventCountryListResponseResultJSON `json:"-"`
}
func (*ThreatEventCountryListResponseResult) UnmarshalJSON ¶
func (r *ThreatEventCountryListResponseResult) UnmarshalJSON(data []byte) (err error)
type ThreatEventCountryService ¶
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 ¶
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 ¶
func (r *ThreatEventCountryService) List(ctx context.Context, query ThreatEventCountryListParams, opts ...option.RequestOption) (res *[]ThreatEventCountryListResponse, err error)
Retrieves countries information for all countries
type ThreatEventCronService ¶
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 ¶
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.
type ThreatEventDatasetEditParams ¶
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 ¶
func (r ThreatEventDatasetEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetEditResponse ¶
type ThreatEventDatasetEditResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetEditResponseJSON `json:"-"`
}
func (*ThreatEventDatasetEditResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetGetResponse ¶
type ThreatEventDatasetGetResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetGetResponseJSON `json:"-"`
}
func (*ThreatEventDatasetGetResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetHealthService ¶
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 ¶
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.
type ThreatEventDatasetListResponse ¶
type ThreatEventDatasetListResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventDatasetListResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetNewParams ¶
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 ¶
func (r ThreatEventDatasetNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetNewResponse ¶
type ThreatEventDatasetNewResponse struct {
IsPublic bool `json:"isPublic,required"`
Name string `json:"name,required"`
UUID string `json:"uuid,required"`
JSON threatEventDatasetNewResponseJSON `json:"-"`
}
func (*ThreatEventDatasetNewResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetRawResponse ¶
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 ¶
func (r *ThreatEventDatasetRawResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetService ¶
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 ¶
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 ¶
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 ¶
func (r *ThreatEventDatasetService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetGetResponse, err error)
Reads a dataset
func (*ThreatEventDatasetService) List ¶
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 ¶
func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventDatasetNewParams, opts ...option.RequestOption) (res *ThreatEventDatasetNewResponse, err error)
Creates a dataset
func (*ThreatEventDatasetService) Raw ¶
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 ¶
type ThreatEventDeleteResponse ¶
type ThreatEventDeleteResponse struct {
UUID string `json:"uuid,required"`
JSON threatEventDeleteResponseJSON `json:"-"`
}
func (*ThreatEventDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEditParams ¶
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"`
CreatedAt param.Field[time.Time] `json:"createdAt" format:"date-time"`
DatasetID param.Field[string] `json:"datasetId"`
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"`
Insight param.Field[string] `json:"insight"`
Raw param.Field[ThreatEventEditParamsRaw] `json:"raw"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventEditParams) MarshalJSON ¶
func (r ThreatEventEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventEditParamsRaw ¶
type ThreatEventEditParamsRaw struct {
Data param.Field[map[string]interface{}] `json:"data"`
Source param.Field[string] `json:"source"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventEditParamsRaw) MarshalJSON ¶
func (r ThreatEventEditParamsRaw) MarshalJSON() (data []byte, err error)
type ThreatEventEditResponse ¶
type ThreatEventEditResponse struct {
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"`
HasChildren bool `json:"hasChildren,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 ¶
func (r *ThreatEventEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagDeleteResponse ¶
type ThreatEventEventTagDeleteResponse struct {
Success bool `json:"success,required"`
JSON threatEventEventTagDeleteResponseJSON `json:"-"`
}
func (*ThreatEventEventTagDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventEventTagDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagDeleteResponseEnvelope ¶
type ThreatEventEventTagDeleteResponseEnvelope struct {
Result ThreatEventEventTagDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventEventTagDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventEventTagDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ThreatEventEventTagDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagNewParams ¶
type ThreatEventEventTagNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Tags param.Field[[]string] `json:"tags,required"`
}
func (ThreatEventEventTagNewParams) MarshalJSON ¶
func (r ThreatEventEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventEventTagNewResponse ¶
type ThreatEventEventTagNewResponse struct {
Success bool `json:"success,required"`
JSON threatEventEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventEventTagNewResponse) UnmarshalJSON ¶
func (r *ThreatEventEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagNewResponseEnvelope ¶
type ThreatEventEventTagNewResponseEnvelope struct {
Result ThreatEventEventTagNewResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventEventTagNewResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventEventTagNewResponseEnvelope) UnmarshalJSON ¶
func (r *ThreatEventEventTagNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagService ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ThreatEventGetResponse ¶
type ThreatEventGetResponse struct {
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"`
HasChildren bool `json:"hasChildren,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 ¶
func (r *ThreatEventGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeListResponse ¶
type ThreatEventIndicatorTypeListResponse struct {
Items ThreatEventIndicatorTypeListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventIndicatorTypeListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorTypeListResponse) UnmarshalJSON ¶
func (r *ThreatEventIndicatorTypeListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeListResponseItems ¶
type ThreatEventIndicatorTypeListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventIndicatorTypeListResponseItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorTypeListResponseItems) UnmarshalJSON ¶
func (r *ThreatEventIndicatorTypeListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeService ¶
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 ¶
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
deprecated
func (r *ThreatEventIndicatorTypeService) List(ctx context.Context, query ThreatEventIndicatorTypeListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorTypeListResponse, err error)
This Method is deprecated. Please use /events/dataset/:dataset_id/indicatorTypes instead.
Deprecated: deprecated
type ThreatEventInsightService ¶
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 ¶
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.
type ThreatEventListParams ¶
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"`
Format param.Field[ThreatEventListParamsFormat] `query:"format"`
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 ¶
func (r ThreatEventListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventListParams's query parameters as `url.Values`.
type ThreatEventListParamsFormat ¶ added in v6.6.0
type ThreatEventListParamsFormat string
const ( ThreatEventListParamsFormatJson ThreatEventListParamsFormat = "json" ThreatEventListParamsFormatStix2 ThreatEventListParamsFormat = "stix2" )
func (ThreatEventListParamsFormat) IsKnown ¶ added in v6.6.0
func (r ThreatEventListParamsFormat) IsKnown() bool
type ThreatEventListParamsOrder ¶
type ThreatEventListParamsOrder string
const ( ThreatEventListParamsOrderAsc ThreatEventListParamsOrder = "asc" ThreatEventListParamsOrderDesc ThreatEventListParamsOrder = "desc" )
func (ThreatEventListParamsOrder) IsKnown ¶
func (r ThreatEventListParamsOrder) IsKnown() bool
type ThreatEventListParamsSearch ¶
type ThreatEventListParamsSearch struct {
Field param.Field[string] `query:"field"`
Op param.Field[ThreatEventListParamsSearchOp] `query:"op"`
Value param.Field[ThreatEventListParamsSearchValueUnion] `query:"value"`
}
func (ThreatEventListParamsSearch) URLQuery ¶
func (r ThreatEventListParamsSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventListParamsSearch's query parameters as `url.Values`.
type ThreatEventListParamsSearchOp ¶
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 ¶
func (r ThreatEventListParamsSearchOp) IsKnown() bool
type ThreatEventListParamsSearchValueArray ¶
type ThreatEventListParamsSearchValueArray []ThreatEventListParamsSearchValueArrayItemUnion
func (ThreatEventListParamsSearchValueArray) ImplementsThreatEventListParamsSearchValueUnion ¶
func (r ThreatEventListParamsSearchValueArray) ImplementsThreatEventListParamsSearchValueUnion()
type ThreatEventListParamsSearchValueArrayItemUnion ¶
type ThreatEventListParamsSearchValueArrayItemUnion interface {
ImplementsThreatEventListParamsSearchValueArrayItemUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type ThreatEventListParamsSearchValueUnion ¶
type ThreatEventListParamsSearchValueUnion interface {
ImplementsThreatEventListParamsSearchValueUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventListParamsSearchValueArray.
type ThreatEventListResponse ¶
type ThreatEventListResponse struct {
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"`
HasChildren bool `json:"hasChildren,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 ¶
func (r *ThreatEventListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventNewParams ¶
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"`
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"`
// Array of indicators for this event. Supports multiple indicators per event for
// complex scenarios.
Indicators param.Field[[]ThreatEventNewParamsIndicator] `json:"indicators"`
IndicatorType param.Field[string] `json:"indicatorType"`
Insight param.Field[string] `json:"insight"`
Tags param.Field[[]string] `json:"tags"`
TargetCountry param.Field[string] `json:"targetCountry"`
TargetIndustry param.Field[string] `json:"targetIndustry"`
// Optional UUID for the event. Only used when preserveUuid=true in bulk create.
// Must be a valid UUID format.
UUID param.Field[string] `json:"uuid"`
}
func (ThreatEventNewParams) MarshalJSON ¶
func (r ThreatEventNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventNewParamsIndicator ¶ added in v6.4.0
type ThreatEventNewParamsIndicator struct {
// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
IndicatorType param.Field[string] `json:"indicatorType,required"`
// The indicator value (e.g., domain name, IP address, hash)
Value param.Field[string] `json:"value,required"`
}
func (ThreatEventNewParamsIndicator) MarshalJSON ¶ added in v6.4.0
func (r ThreatEventNewParamsIndicator) MarshalJSON() (data []byte, err error)
type ThreatEventNewParamsRaw ¶
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 ¶
func (r ThreatEventNewParamsRaw) MarshalJSON() (data []byte, err error)
type ThreatEventNewResponse ¶
type ThreatEventNewResponse struct {
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"`
HasChildren bool `json:"hasChildren,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 ¶
func (r *ThreatEventNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawEditParams ¶
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 ¶
func (r ThreatEventRawEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventRawEditResponse ¶
type ThreatEventRawEditResponse struct {
ID string `json:"id,required"`
Data interface{} `json:"data,required"`
JSON threatEventRawEditResponseJSON `json:"-"`
}
func (*ThreatEventRawEditResponse) UnmarshalJSON ¶
func (r *ThreatEventRawEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawGetParams ¶
type ThreatEventRawGetResponse ¶
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 ¶
func (r *ThreatEventRawGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRawService ¶
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 ¶
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 ¶
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 ¶
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 ThreatEventRelateDeleteResponse ¶
type ThreatEventRelateDeleteResponse struct {
Success bool `json:"success,required"`
JSON threatEventRelateDeleteResponseJSON `json:"-"`
}
func (*ThreatEventRelateDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventRelateDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelateDeleteResponseEnvelope ¶
type ThreatEventRelateDeleteResponseEnvelope struct {
Result ThreatEventRelateDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON threatEventRelateDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventRelateDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ThreatEventRelateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelateService ¶
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 ¶
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 ¶
func (r *ThreatEventRelateService) Delete(ctx context.Context, eventID string, body ThreatEventRelateDeleteParams, opts ...option.RequestOption) (res *ThreatEventRelateDeleteResponse, err error)
Removes an event reference
type ThreatEventService ¶
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 ¶
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 ¶
func (r *ThreatEventService) BulkNew(ctx context.Context, params ThreatEventBulkNewParams, opts ...option.RequestOption) (res *ThreatEventBulkNewResponse, 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 ¶
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 ¶
func (r *ThreatEventService) Edit(ctx context.Context, eventID string, params ThreatEventEditParams, opts ...option.RequestOption) (res *ThreatEventEditResponse, err error)
Updates an event
func (*ThreatEventService) Get
deprecated
func (r *ThreatEventService) Get(ctx context.Context, eventID string, query ThreatEventGetParams, opts ...option.RequestOption) (res *ThreatEventGetResponse, err error)
This Method is deprecated. Please use /events/dataset/:dataset_id/events/:event_id instead.
Deprecated: deprecated
func (*ThreatEventService) List ¶
func (r *ThreatEventService) List(ctx context.Context, params ThreatEventListParams, opts ...option.RequestOption) (res *[]ThreatEventListResponse, err error)
When `datasetId` is unspecified, events will be listed from the `Cloudforce One Threat Events` dataset. 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 ¶
func (r *ThreatEventService) New(ctx context.Context, params ThreatEventNewParams, opts ...option.RequestOption) (res *ThreatEventNewResponse, err error)
To create a dataset, see the [`Create Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/) endpoint. When `datasetId` parameter is unspecified, it will be created in a default dataset named `Cloudforce One Threat Events`.
type ThreatEventTagNewParams ¶
type ThreatEventTagNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Value param.Field[string] `json:"value,required"`
ActiveDuration param.Field[string] `json:"activeDuration"`
ActorCategory param.Field[string] `json:"actorCategory"`
AliasGroupNames param.Field[[]string] `json:"aliasGroupNames"`
AliasGroupNamesInternal param.Field[[]string] `json:"aliasGroupNamesInternal"`
AnalyticPriority param.Field[float64] `json:"analyticPriority"`
AttributionConfidence param.Field[string] `json:"attributionConfidence"`
AttributionOrganization param.Field[string] `json:"attributionOrganization"`
CategoryUUID param.Field[string] `json:"categoryUuid"`
ExternalReferenceLinks param.Field[[]string] `json:"externalReferenceLinks"`
InternalDescription param.Field[string] `json:"internalDescription"`
Motive param.Field[string] `json:"motive"`
OpsecLevel param.Field[string] `json:"opsecLevel"`
OriginCountryISO param.Field[string] `json:"originCountryISO"`
Priority param.Field[float64] `json:"priority"`
SophisticationLevel param.Field[string] `json:"sophisticationLevel"`
}
func (ThreatEventTagNewParams) MarshalJSON ¶
func (r ThreatEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewResponse ¶
type ThreatEventTagNewResponse struct {
UUID string `json:"uuid,required"`
Value string `json:"value,required"`
ActiveDuration string `json:"activeDuration"`
ActorCategory string `json:"actorCategory"`
AliasGroupNames []string `json:"aliasGroupNames"`
AliasGroupNamesInternal []string `json:"aliasGroupNamesInternal"`
AnalyticPriority float64 `json:"analyticPriority"`
AttributionConfidence string `json:"attributionConfidence"`
AttributionOrganization string `json:"attributionOrganization"`
CategoryName string `json:"categoryName"`
CategoryUUID string `json:"categoryUuid"`
ExternalReferenceLinks []string `json:"externalReferenceLinks"`
InternalDescription string `json:"internalDescription"`
Motive string `json:"motive"`
OpsecLevel string `json:"opsecLevel"`
OriginCountryISO string `json:"originCountryISO"`
Priority float64 `json:"priority"`
SophisticationLevel string `json:"sophisticationLevel"`
JSON threatEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventTagNewResponse) UnmarshalJSON ¶
func (r *ThreatEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagService ¶
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 ¶
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 ¶
func (r *ThreatEventTagService) New(ctx context.Context, params ThreatEventTagNewParams, opts ...option.RequestOption) (res *ThreatEventTagNewResponse, err error)
Creates a new tag to be used accross threat events.
type ThreatEventTargetIndustryListParams ¶
type ThreatEventTargetIndustryListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
// Array of dataset IDs to query target industries from. If not provided, uses the
// default dataset.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
}
func (ThreatEventTargetIndustryListParams) URLQuery ¶ added in v6.3.0
func (r ThreatEventTargetIndustryListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTargetIndustryListParams's query parameters as `url.Values`.
type ThreatEventTargetIndustryListResponse ¶
type ThreatEventTargetIndustryListResponse struct {
Items ThreatEventTargetIndustryListResponseItems `json:"items,required"`
Type string `json:"type,required"`
JSON threatEventTargetIndustryListResponseJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponse) UnmarshalJSON ¶
func (r *ThreatEventTargetIndustryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryListResponseItems ¶
type ThreatEventTargetIndustryListResponseItems struct {
Type string `json:"type,required"`
JSON threatEventTargetIndustryListResponseItemsJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponseItems) UnmarshalJSON ¶
func (r *ThreatEventTargetIndustryListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryService ¶
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 ¶
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 ¶
func (r *ThreatEventTargetIndustryService) List(ctx context.Context, params ThreatEventTargetIndustryListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryListResponse, err error)
Lists target industries across multiple datasets
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
Source Files
¶
- aliases.go
- binarystorage.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