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 ThreatEventAggregateListParams
- type ThreatEventAggregateListResponse
- type ThreatEventAggregateListResponseAggregation
- type ThreatEventAggregateListResponseDateRange
- type ThreatEventAggregateService
- type ThreatEventAttackerListParams
- type ThreatEventAttackerListResponse
- type ThreatEventAttackerListResponseItems
- type ThreatEventAttackerService
- type ThreatEventBulkNewParams
- type ThreatEventBulkNewParamsData
- type ThreatEventBulkNewParamsDataIndicator
- type ThreatEventBulkNewParamsDataRaw
- type ThreatEventBulkNewRelationshipsParams
- type ThreatEventBulkNewRelationshipsParamsData
- type ThreatEventBulkNewRelationshipsParamsDataIndicator
- type ThreatEventBulkNewRelationshipsParamsDataRaw
- type ThreatEventBulkNewRelationshipsResponse
- type ThreatEventBulkNewRelationshipsResponseError
- type ThreatEventBulkNewResponse
- type ThreatEventBulkNewResponseCreatedEvent
- type ThreatEventBulkNewResponseError
- type ThreatEventCategoryCatalogListParams
- type ThreatEventCategoryCatalogListResponse
- type ThreatEventCategoryCatalogService
- 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 ThreatEventDatasetDeleteParams
- type ThreatEventDatasetDeleteResponse
- type ThreatEventDatasetEditParams
- type ThreatEventDatasetEditResponse
- type ThreatEventDatasetEventGetParams
- type ThreatEventDatasetEventGetResponse
- type ThreatEventDatasetEventService
- type ThreatEventDatasetGetParams
- type ThreatEventDatasetGetResponse
- type ThreatEventDatasetHealthService
- type ThreatEventDatasetListParams
- type ThreatEventDatasetListResponse
- type ThreatEventDatasetListResponseIndicatorWriteMode
- type ThreatEventDatasetNewParams
- type ThreatEventDatasetNewResponse
- type ThreatEventDatasetRawParams
- type ThreatEventDatasetRawResponse
- type ThreatEventDatasetService
- func (r *ThreatEventDatasetService) Delete(ctx context.Context, datasetID string, body ThreatEventDatasetDeleteParams, ...) (res *ThreatEventDatasetDeleteResponse, err error)
- 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, params 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 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 ThreatEventGraphListParams
- type ThreatEventGraphListResponse
- type ThreatEventGraphListResponseEdge
- type ThreatEventGraphListResponseEnvelope
- type ThreatEventGraphListResponseEnvelopeResultInfo
- type ThreatEventGraphService
- type ThreatEventGraphqlNewParams
- type ThreatEventGraphqlNewResponse
- type ThreatEventGraphqlService
- type ThreatEventIndicatorAggregateListParams
- type ThreatEventIndicatorAggregateListParamsCreatedAfterUnion
- type ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion
- type ThreatEventIndicatorAggregateListParamsMeasure
- type ThreatEventIndicatorAggregateListResponse
- type ThreatEventIndicatorAggregateListResponseAggregation
- type ThreatEventIndicatorAggregateService
- type ThreatEventIndicatorByDatasetGetParams
- type ThreatEventIndicatorByDatasetGetResponse
- type ThreatEventIndicatorByDatasetGetResponseRelatedEvent
- type ThreatEventIndicatorByDatasetGetResponseTag
- type ThreatEventIndicatorByDatasetListParams
- type ThreatEventIndicatorByDatasetListResponse
- type ThreatEventIndicatorByDatasetListResponseIndicator
- type ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent
- type ThreatEventIndicatorByDatasetListResponseIndicatorsTag
- type ThreatEventIndicatorByDatasetListResponsePagination
- type ThreatEventIndicatorByDatasetService
- func (r *ThreatEventIndicatorByDatasetService) Get(ctx context.Context, datasetID string, indicatorID string, ...) (res *ThreatEventIndicatorByDatasetGetResponse, err error)
- func (r *ThreatEventIndicatorByDatasetService) List(ctx context.Context, datasetID string, ...) (res *ThreatEventIndicatorByDatasetListResponse, err error)deprecated
- type ThreatEventIndicatorByDatasetTagListParams
- type ThreatEventIndicatorByDatasetTagListResponse
- type ThreatEventIndicatorByDatasetTagService
- type ThreatEventIndicatorListParams
- type ThreatEventIndicatorListParamsCache
- type ThreatEventIndicatorListParamsFormat
- type ThreatEventIndicatorListParamsSearch
- type ThreatEventIndicatorListParamsSearchField
- type ThreatEventIndicatorListParamsSearchOp
- type ThreatEventIndicatorListParamsSearchValueArray
- type ThreatEventIndicatorListParamsSearchValueUnion
- type ThreatEventIndicatorListParamsTagSearch
- type ThreatEventIndicatorListParamsTagSearchField
- type ThreatEventIndicatorListParamsTagSearchOp
- type ThreatEventIndicatorListParamsTagSearchValueArray
- type ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion
- type ThreatEventIndicatorListParamsTagSearchValueUnion
- type ThreatEventIndicatorListResponse
- type ThreatEventIndicatorListResponseProperties
- type ThreatEventIndicatorListResponsePropertiesCompleteness
- type ThreatEventIndicatorListResponsePropertiesCompletenessProperties
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings
- type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems
- type ThreatEventIndicatorListResponsePropertiesIndicators
- type ThreatEventIndicatorListResponsePropertiesIndicatorsItems
- type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent
- type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag
- type ThreatEventIndicatorListResponsePropertiesPagination
- type ThreatEventIndicatorListResponsePropertiesPaginationProperties
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount
- type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact
- type ThreatEventIndicatorService
- type ThreatEventIndicatorTypeListParams
- type ThreatEventIndicatorTypeListResponse
- type ThreatEventIndicatorTypeListResponseItems
- type ThreatEventIndicatorTypeService
- type ThreatEventInsightService
- type ThreatEventListParams
- type ThreatEventListParamsCache
- 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 ThreatEventQueryDeleteParams
- type ThreatEventQueryEditParams
- type ThreatEventQueryEditResponse
- type ThreatEventQueryGetParams
- type ThreatEventQueryGetResponse
- type ThreatEventQueryListParams
- type ThreatEventQueryListResponse
- type ThreatEventQueryNewParams
- type ThreatEventQueryNewResponse
- type ThreatEventQueryService
- func (r *ThreatEventQueryService) Delete(ctx context.Context, queryID int64, body ThreatEventQueryDeleteParams, ...) (err error)
- func (r *ThreatEventQueryService) Edit(ctx context.Context, queryID int64, params ThreatEventQueryEditParams, ...) (res *ThreatEventQueryEditResponse, err error)
- func (r *ThreatEventQueryService) Get(ctx context.Context, queryID int64, query ThreatEventQueryGetParams, ...) (res *ThreatEventQueryGetResponse, err error)
- func (r *ThreatEventQueryService) List(ctx context.Context, query ThreatEventQueryListParams, ...) (res *[]ThreatEventQueryListResponse, err error)
- func (r *ThreatEventQueryService) New(ctx context.Context, params ThreatEventQueryNewParams, ...) (res *ThreatEventQueryNewResponse, err error)
- type ThreatEventRawEditParams
- type ThreatEventRawEditResponse
- type ThreatEventRawGetParams
- type ThreatEventRawGetResponse
- type ThreatEventRawService
- type ThreatEventRelateDeleteParams
- type ThreatEventRelateDeleteResponse
- type ThreatEventRelateDeleteResponseEnvelope
- type ThreatEventRelateService
- type ThreatEventRelationshipListParams
- type ThreatEventRelationshipListParamsDirection
- type ThreatEventRelationshipListParamsRelationshipTypesArray
- type ThreatEventRelationshipListParamsRelationshipTypesUnion
- type ThreatEventRelationshipListResponse
- type ThreatEventRelationshipService
- type ThreatEventService
- func (r *ThreatEventService) BulkNew(ctx context.Context, params ThreatEventBulkNewParams, ...) (res *ThreatEventBulkNewResponse, err error)
- func (r *ThreatEventService) BulkNewRelationships(ctx context.Context, params ThreatEventBulkNewRelationshipsParams, ...) (res *ThreatEventBulkNewRelationshipsResponse, err error)deprecated
- 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 ThreatEventTagCategoryDeleteParams
- type ThreatEventTagCategoryDeleteResponse
- type ThreatEventTagCategoryEditParams
- type ThreatEventTagCategoryEditResponse
- type ThreatEventTagCategoryListParams
- type ThreatEventTagCategoryListResponse
- type ThreatEventTagCategoryListResponseCategory
- type ThreatEventTagCategoryNewParams
- type ThreatEventTagCategoryNewResponse
- type ThreatEventTagCategoryService
- func (r *ThreatEventTagCategoryService) Delete(ctx context.Context, categoryUUID string, ...) (res *ThreatEventTagCategoryDeleteResponse, err error)
- func (r *ThreatEventTagCategoryService) Edit(ctx context.Context, categoryUUID string, ...) (res *ThreatEventTagCategoryEditResponse, err error)
- func (r *ThreatEventTagCategoryService) List(ctx context.Context, params ThreatEventTagCategoryListParams, ...) (res *ThreatEventTagCategoryListResponse, err error)
- func (r *ThreatEventTagCategoryService) New(ctx context.Context, params ThreatEventTagCategoryNewParams, ...) (res *ThreatEventTagCategoryNewResponse, err error)
- type ThreatEventTagDeleteParams
- type ThreatEventTagDeleteResponse
- type ThreatEventTagEditParams
- type ThreatEventTagEditParamsAlias
- type ThreatEventTagEditParamsAliasesTLP
- type ThreatEventTagEditParamsExternalReference
- type ThreatEventTagEditParamsInternalAlias
- type ThreatEventTagEditParamsInternalAliasesTLP
- type ThreatEventTagEditParamsOriginCountryTLP
- type ThreatEventTagEditResponse
- type ThreatEventTagEditResponseAlias
- type ThreatEventTagEditResponseAliasesTLP
- type ThreatEventTagEditResponseExternalReference
- type ThreatEventTagEditResponseInternalAlias
- type ThreatEventTagEditResponseInternalAliasesTLP
- type ThreatEventTagEditResponseOriginCountryTLP
- type ThreatEventTagIndicatorByDatasetListParams
- type ThreatEventTagIndicatorByDatasetListParamsSearch
- type ThreatEventTagIndicatorByDatasetListParamsSearchField
- type ThreatEventTagIndicatorByDatasetListParamsSearchOp
- type ThreatEventTagIndicatorByDatasetListParamsSearchValueArray
- type ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion
- type ThreatEventTagIndicatorByDatasetListResponse
- type ThreatEventTagIndicatorByDatasetListResponseIndicator
- type ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent
- type ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag
- type ThreatEventTagIndicatorByDatasetListResponsePagination
- type ThreatEventTagIndicatorByDatasetService
- type ThreatEventTagIndicatorListParams
- type ThreatEventTagIndicatorListParamsSearch
- type ThreatEventTagIndicatorListParamsSearchField
- type ThreatEventTagIndicatorListParamsSearchOp
- type ThreatEventTagIndicatorListParamsSearchValueArray
- type ThreatEventTagIndicatorListParamsSearchValueUnion
- type ThreatEventTagIndicatorListResponse
- type ThreatEventTagIndicatorListResponseIndicator
- type ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent
- type ThreatEventTagIndicatorListResponseIndicatorsTag
- type ThreatEventTagIndicatorListResponsePagination
- type ThreatEventTagIndicatorService
- type ThreatEventTagListParams
- type ThreatEventTagListParamsCache
- type ThreatEventTagListParamsFilter
- type ThreatEventTagListParamsFiltersField
- type ThreatEventTagListParamsFiltersOp
- type ThreatEventTagListParamsFiltersValueArray
- type ThreatEventTagListParamsFiltersValueArrayItemUnion
- type ThreatEventTagListParamsFiltersValueUnion
- type ThreatEventTagListResponse
- type ThreatEventTagListResponsePagination
- type ThreatEventTagListResponseTag
- type ThreatEventTagListResponseTagsAlias
- type ThreatEventTagListResponseTagsAliasesTLP
- type ThreatEventTagListResponseTagsExternalReference
- type ThreatEventTagListResponseTagsInternalAlias
- type ThreatEventTagListResponseTagsInternalAliasesTLP
- type ThreatEventTagListResponseTagsOriginCountryTLP
- type ThreatEventTagNewParams
- type ThreatEventTagNewParamsAlias
- type ThreatEventTagNewParamsAliasesTLP
- type ThreatEventTagNewParamsExternalReference
- type ThreatEventTagNewParamsInternalAlias
- type ThreatEventTagNewParamsInternalAliasesTLP
- type ThreatEventTagNewParamsOriginCountryTLP
- type ThreatEventTagNewResponse
- type ThreatEventTagNewResponseAlias
- type ThreatEventTagNewResponseAliasesTLP
- type ThreatEventTagNewResponseExternalReference
- type ThreatEventTagNewResponseInternalAlias
- type ThreatEventTagNewResponseInternalAliasesTLP
- type ThreatEventTagNewResponseOriginCountryTLP
- type ThreatEventTagService
- func (r *ThreatEventTagService) Delete(ctx context.Context, tagUUID string, body ThreatEventTagDeleteParams, ...) (res *ThreatEventTagDeleteResponse, err error)
- func (r *ThreatEventTagService) Edit(ctx context.Context, tagUUID string, params ThreatEventTagEditParams, ...) (res *ThreatEventTagEditResponse, err error)
- func (r *ThreatEventTagService) List(ctx context.Context, params ThreatEventTagListParams, ...) (res *ThreatEventTagListResponse, err error)
- func (r *ThreatEventTagService) New(ctx context.Context, params ThreatEventTagNewParams, ...) (res *ThreatEventTagNewResponse, err error)
- type ThreatEventTargetIndustryByDatasetListParams
- type ThreatEventTargetIndustryByDatasetListResponse
- type ThreatEventTargetIndustryByDatasetListResponseItems
- type ThreatEventTargetIndustryByDatasetService
- type ThreatEventTargetIndustryCatalogListParams
- type ThreatEventTargetIndustryCatalogListResponse
- type ThreatEventTargetIndustryCatalogListResponseItems
- type ThreatEventTargetIndustryCatalogService
- 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" api:"required"`
// The binary file content to upload.
File param.Field[io.Reader] `json:"file" api:"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" api:"required"`
Md5 string `json:"md5" api:"required"`
Sha1 string `json:"sha1" api:"required"`
Sha256 string `json:"sha256" api:"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 binary file from the Cloudforce One binary storage for analysis.
func (*BinaryStorageService) New ¶
func (r *BinaryStorageService) New(ctx context.Context, params BinaryStorageNewParams, opts ...option.RequestOption) (res *BinaryStorageNewResponse, err error)
Uploads a binary file to Cloudforce One's binary database for malware analysis and threat intelligence correlation.
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" api:"required"`
// Request content.
Content string `json:"content" api:"required"`
Created time.Time `json:"created" api:"required" format:"date-time"`
Priority time.Time `json:"priority" api:"required" format:"date-time"`
// Requested information from request.
Request string `json:"request" api:"required"`
// Brief description of the request.
Summary string `json:"summary" api:"required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP ItemTLP `json:"tlp" api:"required"`
Updated time.Time `json:"updated" api:"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" api:"required"`
// Request creation time.
Created time.Time `json:"created" api:"required" format:"date-time"`
Priority ListItemPriority `json:"priority" api:"required"`
// Requested information from request.
Request string `json:"request" api:"required"`
// Brief description of the request.
Summary string `json:"summary" api:"required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP ListItemTLP `json:"tlp" api:"required"`
// Request last updated time.
Updated time.Time `json:"updated" api:"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" api:"required"`
// Author of message.
Author string `json:"author" api:"required"`
// Content of message.
Content string `json:"content" api:"required"`
// Whether the message is a follow-on request.
IsFollowOnRequest bool `json:"is_follow_on_request" api:"required"`
// Defines the message last updated time.
Updated time.Time `json:"updated" api:"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" api:"required"`
// Priority creation time.
Created time.Time `json:"created" api:"required" format:"date-time"`
// List of labels.
Labels []Label `json:"labels" api:"required"`
// Priority.
Priority int64 `json:"priority" api:"required"`
// Requirement.
Requirement string `json:"requirement" api:"required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP PriorityTLP `json:"tlp" api:"required"`
// Priority last updated time.
Updated time.Time `json:"updated" api:"required" format:"date-time"`
JSON priorityJSON `json:"-"`
}
func (*Priority) UnmarshalJSON ¶
type PriorityEditParam ¶
type PriorityEditParam struct {
// List of labels.
Labels param.Field[[]LabelParam] `json:"labels" api:"required"`
// Priority.
Priority param.Field[int64] `json:"priority" api:"required"`
// Requirement.
Requirement param.Field[string] `json:"requirement" api:"required"`
// The CISA defined Traffic Light Protocol (TLP).
TLP param.Field[PriorityEditTLP] `json:"tlp" api:"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" api:"required"`
Messages []RequestAssetDeleteResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestAssetDeleteResponseSuccess `json:"success" api:"required"`
JSON requestAssetDeleteResponseJSON `json:"-"`
}
func (*RequestAssetDeleteResponse) UnmarshalJSON ¶
func (r *RequestAssetDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestAssetDeleteResponseError ¶
type RequestAssetDeleteResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
// Asset name.
Name string `json:"name" api:"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" api:"required"`
// Page number of results.
Page param.Field[int64] `json:"page" api:"required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page" api:"required"`
}
func (RequestAssetNewParams) MarshalJSON ¶
func (r RequestAssetNewParams) MarshalJSON() (data []byte, err error)
type RequestAssetNewResponse ¶
type RequestAssetNewResponse struct {
// Asset ID.
ID int64 `json:"id" api:"required"`
// Asset name.
Name string `json:"name" api:"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)
Removes an asset from a Cloudforce One intelligence request.
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)
Retrieves an asset attached to a Cloudforce One intelligence request.
func (*RequestAssetService) GetAutoPaging ¶
func (r *RequestAssetService) GetAutoPaging(ctx context.Context, requestID string, assetID string, query RequestAssetGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetGetResponse]
Retrieves an asset attached to a Cloudforce One intelligence request.
func (*RequestAssetService) New ¶
func (r *RequestAssetService) New(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[RequestAssetNewResponse], err error)
Lists assets attached to a Cloudforce One intelligence request.
func (*RequestAssetService) NewAutoPaging ¶
func (r *RequestAssetService) NewAutoPaging(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetNewResponse]
Lists assets attached to a Cloudforce One intelligence request.
func (*RequestAssetService) Update ¶
func (r *RequestAssetService) Update(ctx context.Context, requestID string, assetID string, params RequestAssetUpdateParams, opts ...option.RequestOption) (res *RequestAssetUpdateResponse, err error)
Updates an asset in a Cloudforce One intelligence request.
type RequestAssetUpdateParams ¶
type RequestAssetUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"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" api:"required"`
// Asset name.
Name string `json:"name" api:"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" api:"required"`
Messages []RequestAssetUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestAssetUpdateResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestConstantsResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestConstantsResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestDeleteResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestDeleteResponseSuccess `json:"success" api:"required"`
JSON requestDeleteResponseJSON `json:"-"`
}
func (*RequestDeleteResponse) UnmarshalJSON ¶
func (r *RequestDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestDeleteResponseError ¶
type RequestDeleteResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestGetResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
// Page number of results.
Page param.Field[int64] `json:"page" api:"required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page" api:"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" api:"required"`
Messages []RequestMessageDeleteResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestMessageDeleteResponseSuccess `json:"success" api:"required"`
JSON requestMessageDeleteResponseJSON `json:"-"`
}
func (*RequestMessageDeleteResponse) UnmarshalJSON ¶
func (r *RequestMessageDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestMessageDeleteResponseError ¶
type RequestMessageDeleteResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
// Page number of results.
Page param.Field[int64] `json:"page" api:"required"`
// Number of results per page.
PerPage param.Field[int64] `json:"per_page" api:"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" api:"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" api:"required"`
Messages []RequestMessageNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestMessageNewResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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)
Removes a message from a Cloudforce One intelligence request thread.
func (*RequestMessageService) Get ¶
func (r *RequestMessageService) Get(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[Message], err error)
Lists messages in a Cloudforce One intelligence request conversation.
func (*RequestMessageService) GetAutoPaging ¶
func (r *RequestMessageService) GetAutoPaging(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Message]
Lists messages in a Cloudforce One intelligence request conversation.
func (*RequestMessageService) New ¶
func (r *RequestMessageService) New(ctx context.Context, requestID string, params RequestMessageNewParams, opts ...option.RequestOption) (res *Message, err error)
Adds a message to a Cloudforce One intelligence request conversation.
func (*RequestMessageService) Update ¶
func (r *RequestMessageService) Update(ctx context.Context, requestID string, messageID int64, params RequestMessageUpdateParams, opts ...option.RequestOption) (res *Message, err error)
Updates a message in a Cloudforce One intelligence request thread.
type RequestMessageUpdateParams ¶
type RequestMessageUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"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" api:"required"`
Messages []RequestMessageUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestMessageUpdateResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"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" api:"required"`
Messages []RequestNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestNewResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestPriorityDeleteResponseMessage `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestPriorityDeleteResponseSuccess `json:"success" api:"required"`
JSON requestPriorityDeleteResponseJSON `json:"-"`
}
func (*RequestPriorityDeleteResponse) UnmarshalJSON ¶
func (r *RequestPriorityDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RequestPriorityDeleteResponseError ¶
type RequestPriorityDeleteResponseError struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestPriorityGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestPriorityGetResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
PriorityEdit PriorityEditParam `json:"priority_edit" api:"required"`
}
func (RequestPriorityNewParams) MarshalJSON ¶
func (r RequestPriorityNewParams) MarshalJSON() (data []byte, err error)
type RequestPriorityNewResponseEnvelope ¶
type RequestPriorityNewResponseEnvelope struct {
Errors []RequestPriorityNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []RequestPriorityNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestPriorityNewResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestPriorityQuotaResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestPriorityQuotaResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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)
Deletes a priority intelligence request from Cloudforce One.
func (*RequestPriorityService) Get ¶
func (r *RequestPriorityService) Get(ctx context.Context, priorityID string, query RequestPriorityGetParams, opts ...option.RequestOption) (res *Item, err error)
Retrieves a specific priority intelligence request from Cloudforce One.
func (*RequestPriorityService) New ¶
func (r *RequestPriorityService) New(ctx context.Context, params RequestPriorityNewParams, opts ...option.RequestOption) (res *Priority, err error)
Creates a new priority intelligence request in Cloudforce One.
func (*RequestPriorityService) Quota ¶
func (r *RequestPriorityService) Quota(ctx context.Context, query RequestPriorityQuotaParams, opts ...option.RequestOption) (res *Quota, err error)
Retrieves quota usage for Cloudforce One priority requests.
func (*RequestPriorityService) Update ¶
func (r *RequestPriorityService) Update(ctx context.Context, priorityID string, params RequestPriorityUpdateParams, opts ...option.RequestOption) (res *Item, err error)
Updates a priority intelligence request in Cloudforce One.
type RequestPriorityUpdateParams ¶
type RequestPriorityUpdateParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
PriorityEdit PriorityEditParam `json:"priority_edit" api:"required"`
}
func (RequestPriorityUpdateParams) MarshalJSON ¶
func (r RequestPriorityUpdateParams) MarshalJSON() (data []byte, err error)
type RequestPriorityUpdateResponseEnvelope ¶
type RequestPriorityUpdateResponseEnvelope struct {
Errors []RequestPriorityUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []RequestPriorityUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestPriorityUpdateResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []RequestQuotaResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestQuotaResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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)
Retrieves constant values used in Cloudforce One requests, including valid statuses and types.
func (*RequestService) Delete ¶
func (r *RequestService) Delete(ctx context.Context, requestID string, body RequestDeleteParams, opts ...option.RequestOption) (res *RequestDeleteResponse, err error)
Deletes a Cloudforce One intelligence request and all associated data.
func (*RequestService) Get ¶
func (r *RequestService) Get(ctx context.Context, requestID string, query RequestGetParams, opts ...option.RequestOption) (res *Item, err error)
Retrieves details for a specific Cloudforce One intelligence request.
func (*RequestService) List ¶
func (r *RequestService) List(ctx context.Context, params RequestListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ListItem], err error)
Lists Cloudforce One intelligence requests with filtering and pagination.
func (*RequestService) ListAutoPaging ¶
func (r *RequestService) ListAutoPaging(ctx context.Context, params RequestListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ListItem]
Lists Cloudforce One intelligence requests with filtering and pagination.
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)
Retrieves quota usage for Cloudforce One standard requests.
func (*RequestService) Types ¶
func (r *RequestService) Types(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)
Lists available request types for Cloudforce One intelligence requests.
func (*RequestService) TypesAutoPaging ¶
func (r *RequestService) TypesAutoPaging(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]
Lists available request types for Cloudforce One intelligence requests.
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" api:"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" api:"required"`
Messages []RequestUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success RequestUpdateResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Messages []string `json:"messages" api:"required"`
Result ScanConfigDeleteResponse `json:"result" api:"required"`
Success bool `json:"success" api:"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" api:"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" api:"required"`
AccountID string `json:"account_id" api:"required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency" api:"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" api:"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" api:"required"`
JSON scanConfigEditResponseJSON `json:"-"`
}
func (*ScanConfigEditResponse) UnmarshalJSON ¶
func (r *ScanConfigEditResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigEditResponseEnvelope ¶
type ScanConfigEditResponseEnvelope struct {
Errors []ScanConfigEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ScanConfigEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success ScanConfigEditResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
AccountID string `json:"account_id" api:"required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency" api:"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" api:"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" api:"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" api:"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" api:"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" api:"required"`
AccountID string `json:"account_id" api:"required"`
// Defines the number of days between each scan (0 = One-off scan).
Frequency float64 `json:"frequency" api:"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" api:"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" api:"required"`
JSON scanConfigNewResponseJSON `json:"-"`
}
func (*ScanConfigNewResponse) UnmarshalJSON ¶
func (r *ScanConfigNewResponse) UnmarshalJSON(data []byte) (err error)
type ScanConfigNewResponseEnvelope ¶
type ScanConfigNewResponseEnvelope struct {
Errors []ScanConfigNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ScanConfigNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success ScanConfigNewResponseEnvelopeSuccess `json:"success" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
Message string `json:"message" api:"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" api:"required"`
JSON scanResultGetResponseJSON `json:"-"`
}
func (*ScanResultGetResponse) UnmarshalJSON ¶
func (r *ScanResultGetResponse) UnmarshalJSON(data []byte) (err error)
type ScanResultGetResponseEnvelope ¶
type ScanResultGetResponseEnvelope struct {
Errors []string `json:"errors" api:"required"`
Messages []string `json:"messages" api:"required"`
Result ScanResultGetResponse `json:"result" api:"required"`
Success bool `json:"success" api:"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 ThreatEventAggregateListParams ¶ added in v7.8.0
type ThreatEventAggregateListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Column(s) to aggregate by - single column or comma-separated list (e.g.,
// 'attacker', 'targetIndustry', 'attacker,targetIndustry')
AggregateBy param.Field[string] `query:"aggregateBy" api:"required"`
// Dataset ID(s) to filter by. Can be a single dataset ID, comma-separated list, or
// array. If not provided, uses default dataset
DatasetID param.Field[[]string] `query:"datasetId"`
// End date for filtering (ISO 8601 format, e.g., '2024-12-31')
EndDate param.Field[string] `query:"endDate"`
// Whether to group results by date (daily aggregation)
GroupByDate param.Field[bool] `query:"groupByDate"`
// Maximum number of results to return
Limit param.Field[float64] `query:"limit"`
// Start date for filtering (ISO 8601 format, e.g., '2024-01-01')
StartDate param.Field[string] `query:"startDate"`
}
func (ThreatEventAggregateListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventAggregateListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventAggregateListParams's query parameters as `url.Values`.
type ThreatEventAggregateListResponse ¶ added in v7.8.0
type ThreatEventAggregateListResponse struct {
// Column(s) that were aggregated by
AggregateBy string `json:"aggregateBy" api:"required"`
// Array of aggregation results with dynamic fields based on aggregateBy columns
Aggregations []ThreatEventAggregateListResponseAggregation `json:"aggregations" api:"required"`
// Total number of events in the aggregation
Total float64 `json:"total" api:"required"`
// Date range used for filtering
DateRange ThreatEventAggregateListResponseDateRange `json:"dateRange"`
JSON threatEventAggregateListResponseJSON `json:"-"`
}
func (*ThreatEventAggregateListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventAggregateListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventAggregateListResponseAggregation ¶ added in v7.8.0
type ThreatEventAggregateListResponseAggregation struct {
// Number of events for this aggregation
Count float64 `json:"count" api:"required"`
// Date (if groupByDate is true)
Date string `json:"date"`
ExtraFields map[string]string `json:"-" api:"extrafields"`
JSON threatEventAggregateListResponseAggregationJSON `json:"-"`
}
func (*ThreatEventAggregateListResponseAggregation) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventAggregateListResponseAggregation) UnmarshalJSON(data []byte) (err error)
type ThreatEventAggregateListResponseDateRange ¶ added in v7.8.0
type ThreatEventAggregateListResponseDateRange struct {
EndDate string `json:"endDate"`
StartDate string `json:"startDate"`
JSON threatEventAggregateListResponseDateRangeJSON `json:"-"`
}
Date range used for filtering
func (*ThreatEventAggregateListResponseDateRange) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventAggregateListResponseDateRange) UnmarshalJSON(data []byte) (err error)
type ThreatEventAggregateService ¶ added in v7.8.0
type ThreatEventAggregateService struct {
Options []option.RequestOption
}
ThreatEventAggregateService 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 NewThreatEventAggregateService method instead.
func NewThreatEventAggregateService ¶ added in v7.8.0
func NewThreatEventAggregateService(opts ...option.RequestOption) (r *ThreatEventAggregateService)
NewThreatEventAggregateService 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 (*ThreatEventAggregateService) List ¶ added in v7.8.0
func (r *ThreatEventAggregateService) List(ctx context.Context, params ThreatEventAggregateListParams, opts ...option.RequestOption) (res *ThreatEventAggregateListResponse, err error)
Aggregate threat events by one or more columns (e.g., attacker, targetIndustry) with optional date filtering and daily grouping. Supports multi-dimensional aggregation for cross-analysis.
type ThreatEventAttackerListParams ¶
type ThreatEventAttackerListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"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 ¶
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" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventAttackerListResponseJSON `json:"-"`
}
func (*ThreatEventAttackerListResponse) UnmarshalJSON ¶
func (r *ThreatEventAttackerListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventAttackerListResponseItems ¶
type ThreatEventAttackerListResponseItems struct {
Type string `json:"type" api:"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 known threat attackers tracked in Cloudforce One threat intelligence.
type ThreatEventBulkNewParams ¶
type ThreatEventBulkNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Data param.Field[[]ThreatEventBulkNewParamsData] `json:"data" api:"required"`
DatasetID param.Field[string] `json:"datasetId" api:"required"`
// When true, response includes array of created event UUIDs and shard IDs. Useful
// for tracking which events were created and where.
IncludeCreatedEvents param.Field[bool] `json:"includeCreatedEvents"`
}
func (ThreatEventBulkNewParams) MarshalJSON ¶
func (r ThreatEventBulkNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsData ¶
type ThreatEventBulkNewParamsData struct {
Category param.Field[string] `json:"category" api:"required"`
Date param.Field[time.Time] `json:"date" api:"required" format:"date-time"`
Event param.Field[string] `json:"event" api:"required"`
Raw param.Field[ThreatEventBulkNewParamsDataRaw] `json:"raw" api:"required"`
TLP param.Field[string] `json:"tlp" api:"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"`
}
func (ThreatEventBulkNewParamsData) MarshalJSON ¶
func (r ThreatEventBulkNewParamsData) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsDataIndicator ¶
type ThreatEventBulkNewParamsDataIndicator struct {
// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
// The indicator value (e.g., domain name, IP address, hash)
Value param.Field[string] `json:"value" api:"required"`
}
func (ThreatEventBulkNewParamsDataIndicator) MarshalJSON ¶
func (r ThreatEventBulkNewParamsDataIndicator) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewParamsDataRaw ¶
type ThreatEventBulkNewParamsDataRaw struct {
Data param.Field[map[string]interface{}] `json:"data" api:"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 ThreatEventBulkNewRelationshipsParams ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Data param.Field[[]ThreatEventBulkNewRelationshipsParamsData] `json:"data" api:"required"`
DatasetID param.Field[string] `json:"datasetId" api:"required"`
}
func (ThreatEventBulkNewRelationshipsParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventBulkNewRelationshipsParams) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewRelationshipsParamsData ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsParamsData struct {
Category param.Field[string] `json:"category" api:"required"`
Date param.Field[time.Time] `json:"date" api:"required" format:"date-time"`
Event param.Field[string] `json:"event" api:"required"`
Raw param.Field[ThreatEventBulkNewRelationshipsParamsDataRaw] `json:"raw" api:"required"`
TLP param.Field[string] `json:"tlp" api:"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[[]ThreatEventBulkNewRelationshipsParamsDataIndicator] `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"`
}
func (ThreatEventBulkNewRelationshipsParamsData) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventBulkNewRelationshipsParamsData) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewRelationshipsParamsDataIndicator ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsParamsDataIndicator struct {
// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
// The indicator value (e.g., domain name, IP address, hash)
Value param.Field[string] `json:"value" api:"required"`
}
func (ThreatEventBulkNewRelationshipsParamsDataIndicator) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventBulkNewRelationshipsParamsDataIndicator) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewRelationshipsParamsDataRaw ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsParamsDataRaw struct {
Data param.Field[map[string]interface{}] `json:"data" api:"required"`
Source param.Field[string] `json:"source"`
TLP param.Field[string] `json:"tlp"`
}
func (ThreatEventBulkNewRelationshipsParamsDataRaw) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventBulkNewRelationshipsParamsDataRaw) MarshalJSON() (data []byte, err error)
type ThreatEventBulkNewRelationshipsResponse ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsResponse struct {
// Number of events created
CreatedEventsCount float64 `json:"createdEventsCount" api:"required"`
// Number of indicators created
CreatedIndicatorsCount float64 `json:"createdIndicatorsCount" api:"required"`
// Number of relationships created
CreatedRelationshipsCount float64 `json:"createdRelationshipsCount" api:"required"`
// Number of errors encountered
ErrorCount float64 `json:"errorCount" api:"required"`
// Array of error details
Errors []ThreatEventBulkNewRelationshipsResponseError `json:"errors"`
JSON threatEventBulkNewRelationshipsResponseJSON `json:"-"`
}
Result of bulk relationship creation operation
func (*ThreatEventBulkNewRelationshipsResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventBulkNewRelationshipsResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventBulkNewRelationshipsResponseError ¶ added in v7.8.0
type ThreatEventBulkNewRelationshipsResponseError struct {
// Error message
Error string `json:"error" api:"required"`
// Index of the event that caused the error
EventIndex float64 `json:"eventIndex" api:"required"`
JSON threatEventBulkNewRelationshipsResponseErrorJSON `json:"-"`
}
func (*ThreatEventBulkNewRelationshipsResponseError) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventBulkNewRelationshipsResponseError) UnmarshalJSON(data []byte) (err error)
type ThreatEventBulkNewResponse ¶
type ThreatEventBulkNewResponse struct {
// Number of events created
CreatedEventsCount float64 `json:"createdEventsCount" api:"required"`
// Number of new tags created in SoT
CreatedTagsCount float64 `json:"createdTagsCount" api:"required"`
// Number of errors encountered
ErrorCount float64 `json:"errorCount" api:"required"`
// Number of indicators queued for async processing
QueuedIndicatorsCount float64 `json:"queuedIndicatorsCount" api:"required"`
// Correlation ID for async indicator processing
CreateBulkEventsRequestID string `json:"createBulkEventsRequestId" format:"uuid"`
// Array of created events with UUIDs and shard locations. Only present when
// includeCreatedEvents=true
CreatedEvents []ThreatEventBulkNewResponseCreatedEvent `json:"createdEvents"`
// Array of error details
Errors []ThreatEventBulkNewResponseError `json:"errors"`
JSON threatEventBulkNewResponseJSON `json:"-"`
}
Detailed result of bulk event creation with auto-tag management
func (*ThreatEventBulkNewResponse) UnmarshalJSON ¶
func (r *ThreatEventBulkNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventBulkNewResponseCreatedEvent ¶
type ThreatEventBulkNewResponseCreatedEvent struct {
// Original index in the input data array
EventIndex float64 `json:"eventIndex" api:"required"`
// Dataset ID of the shard where the event was created
ShardID string `json:"shardId" api:"required"`
// UUID of the created event
UUID string `json:"uuid" api:"required" format:"uuid"`
JSON threatEventBulkNewResponseCreatedEventJSON `json:"-"`
}
func (*ThreatEventBulkNewResponseCreatedEvent) UnmarshalJSON ¶
func (r *ThreatEventBulkNewResponseCreatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventBulkNewResponseError ¶
type ThreatEventBulkNewResponseError struct {
// Error message
Error string `json:"error" api:"required"`
// Index of the event that caused the error
EventIndex float64 `json:"eventIndex" api:"required"`
JSON threatEventBulkNewResponseErrorJSON `json:"-"`
}
func (*ThreatEventBulkNewResponseError) UnmarshalJSON ¶
func (r *ThreatEventBulkNewResponseError) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryCatalogListParams ¶ added in v7.8.0
type ThreatEventCategoryCatalogListResponse ¶ added in v7.8.0
type ThreatEventCategoryCatalogListResponse struct {
KillChain float64 `json:"killChain" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
MitreAttack []string `json:"mitreAttack"`
MitreCapec []string `json:"mitreCapec"`
Shortname string `json:"shortname"`
JSON threatEventCategoryCatalogListResponseJSON `json:"-"`
}
func (*ThreatEventCategoryCatalogListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventCategoryCatalogListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCategoryCatalogService ¶ added in v7.8.0
type ThreatEventCategoryCatalogService struct {
Options []option.RequestOption
}
ThreatEventCategoryCatalogService 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 NewThreatEventCategoryCatalogService method instead.
func NewThreatEventCategoryCatalogService ¶ added in v7.8.0
func NewThreatEventCategoryCatalogService(opts ...option.RequestOption) (r *ThreatEventCategoryCatalogService)
NewThreatEventCategoryCatalogService 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 (*ThreatEventCategoryCatalogService) List ¶ added in v7.8.0
func (r *ThreatEventCategoryCatalogService) List(ctx context.Context, query ThreatEventCategoryCatalogListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryCatalogListResponse, err error)
Lists categories
type ThreatEventCategoryDeleteResponse ¶
type ThreatEventCategoryDeleteResponse struct {
UUID string `json:"uuid" api:"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" api:"required"`
KillChain param.Field[float64] `json:"killChain"`
MitreAttack param.Field[[]string] `json:"mitreAttack"`
MitreCapec param.Field[[]string] `json:"mitreCapec"`
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" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
MitreAttack []string `json:"mitreAttack"`
MitreCapec []string `json:"mitreCapec"`
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" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
MitreAttack []string `json:"mitreAttack"`
MitreCapec []string `json:"mitreCapec"`
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" api:"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 ¶
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" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
MitreAttack []string `json:"mitreAttack"`
MitreCapec []string `json:"mitreCapec"`
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" api:"required"`
KillChain param.Field[float64] `json:"killChain" api:"required"`
Name param.Field[string] `json:"name" api:"required"`
MitreAttack param.Field[[]string] `json:"mitreAttack"`
MitreCapec param.Field[[]string] `json:"mitreCapec"`
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" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
MitreAttack []string `json:"mitreAttack"`
MitreCapec []string `json:"mitreCapec"`
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
Catalog *ThreatEventCategoryCatalogService
}
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)
Removes a threat event category from Cloudforce One.
func (*ThreatEventCategoryService) Edit ¶
func (r *ThreatEventCategoryService) Edit(ctx context.Context, categoryID string, params ThreatEventCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventCategoryEditResponse, err error)
Partially updates a threat event category in Cloudforce One, modifying specific fields without replacing the entire category.
func (*ThreatEventCategoryService) Get ¶
func (r *ThreatEventCategoryService) Get(ctx context.Context, categoryID string, query ThreatEventCategoryGetParams, opts ...option.RequestOption) (res *ThreatEventCategoryGetResponse, err error)
Retrieves details for a specific threat event category.
func (*ThreatEventCategoryService) List ¶
func (r *ThreatEventCategoryService) List(ctx context.Context, params ThreatEventCategoryListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryListResponse, err error)
Lists all threat event categories configured for classifying and organizing threat events.
func (*ThreatEventCategoryService) New ¶
func (r *ThreatEventCategoryService) New(ctx context.Context, params ThreatEventCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventCategoryNewResponse, err error)
Creates a new threat event category in Cloudforce One for organizing and classifying threat events.
type ThreatEventCountryListResponse ¶
type ThreatEventCountryListResponse struct {
Result []ThreatEventCountryListResponseResult `json:"result" api:"required"`
Success string `json:"success" api:"required"`
JSON threatEventCountryListResponseJSON `json:"-"`
}
func (*ThreatEventCountryListResponse) UnmarshalJSON ¶
func (r *ThreatEventCountryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventCountryListResponseResult ¶
type ThreatEventCountryListResponseResult struct {
Alpha2 string `json:"alpha2" api:"required"`
Alpha3 string `json:"alpha3" api:"required"`
Name string `json:"name" api:"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)
Lists countries referenced in Cloudforce One threat intelligence data.
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 ThreatEventDatasetDeleteParams ¶ added in v7.8.0
type ThreatEventDatasetDeleteResponse ¶ added in v7.8.0
type ThreatEventDatasetDeleteResponse struct {
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
JSON threatEventDatasetDeleteResponseJSON `json:"-"`
}
func (*ThreatEventDatasetDeleteResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventDatasetDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetEditParams ¶
type ThreatEventDatasetEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// If true, then anyone can search the dataset. If false, then its limited to the
// account.
IsPublic param.Field[bool] `json:"isPublic" api:"required"`
// Used to describe the dataset within the account context.
Name param.Field[string] `json:"name" api:"required"`
}
func (ThreatEventDatasetEditParams) MarshalJSON ¶
func (r ThreatEventDatasetEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetEditResponse ¶
type ThreatEventDatasetEditResponse struct {
IsAnalytics bool `json:"isAnalytics" api:"required"`
IsPublic bool `json:"isPublic" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
JSON threatEventDatasetEditResponseJSON `json:"-"`
}
func (*ThreatEventDatasetEditResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetEventGetParams ¶ added in v7.8.0
type ThreatEventDatasetEventGetResponse ¶ added in v7.8.0
type ThreatEventDatasetEventGetResponse struct {
Attacker string `json:"attacker" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventDatasetEventGetResponseJSON `json:"-"`
}
func (*ThreatEventDatasetEventGetResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventDatasetEventGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetEventService ¶ added in v7.8.0
type ThreatEventDatasetEventService struct {
Options []option.RequestOption
}
ThreatEventDatasetEventService 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 NewThreatEventDatasetEventService method instead.
func NewThreatEventDatasetEventService ¶ added in v7.8.0
func NewThreatEventDatasetEventService(opts ...option.RequestOption) (r *ThreatEventDatasetEventService)
NewThreatEventDatasetEventService 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 (*ThreatEventDatasetEventService) Get ¶ added in v7.8.0
func (r *ThreatEventDatasetEventService) Get(ctx context.Context, datasetID string, eventID string, query ThreatEventDatasetEventGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetEventGetResponse, err error)
Retrieves a specific event by its UUID.
type ThreatEventDatasetGetResponse ¶
type ThreatEventDatasetGetResponse struct {
IsAnalytics bool `json:"isAnalytics" api:"required"`
IsPublic bool `json:"isPublic" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"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 ThreatEventDatasetListParams ¶
type ThreatEventDatasetListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// When true, include soft-deleted datasets in the response. Each item includes a
// `deletedAt` field (ISO 8601 or null). Default: false.
IncludeDeleted param.Field[bool] `query:"includeDeleted"`
}
func (ThreatEventDatasetListParams) URLQuery ¶ added in v7.7.0
func (r ThreatEventDatasetListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventDatasetListParams's query parameters as `url.Values`.
type ThreatEventDatasetListResponse ¶
type ThreatEventDatasetListResponse struct {
// Effective indicator mutation capability after account/dataset authorization and
// dataset storage capability are applied. API Gateway method permissions are
// separate and must also allow the requested operation.
IndicatorWriteMode ThreatEventDatasetListResponseIndicatorWriteMode `json:"indicatorWriteMode" api:"required"`
IsAnalytics bool `json:"isAnalytics" api:"required"`
IsPublic bool `json:"isPublic" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
DeletedAt string `json:"deletedAt"`
JSON threatEventDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventDatasetListResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetListResponseIndicatorWriteMode ¶ added in v7.9.0
type ThreatEventDatasetListResponseIndicatorWriteMode string
Effective indicator mutation capability after account/dataset authorization and dataset storage capability are applied. API Gateway method permissions are separate and must also allow the requested operation.
const ( ThreatEventDatasetListResponseIndicatorWriteModeReadOnly ThreatEventDatasetListResponseIndicatorWriteMode = "read_only" ThreatEventDatasetListResponseIndicatorWriteModeCreateOnly ThreatEventDatasetListResponseIndicatorWriteMode = "create_only" ThreatEventDatasetListResponseIndicatorWriteModeFull ThreatEventDatasetListResponseIndicatorWriteMode = "full" )
func (ThreatEventDatasetListResponseIndicatorWriteMode) IsKnown ¶ added in v7.9.0
func (r ThreatEventDatasetListResponseIndicatorWriteMode) IsKnown() bool
type ThreatEventDatasetNewParams ¶
type ThreatEventDatasetNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// If true, then anyone can search the dataset. If false, then its limited to the
// account.
IsPublic param.Field[bool] `json:"isPublic" api:"required"`
// Used to describe the dataset within the account context.
Name param.Field[string] `json:"name" api:"required"`
}
func (ThreatEventDatasetNewParams) MarshalJSON ¶
func (r ThreatEventDatasetNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventDatasetNewResponse ¶
type ThreatEventDatasetNewResponse struct {
IsAnalytics bool `json:"isAnalytics" api:"required"`
IsPublic bool `json:"isPublic" api:"required"`
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
JSON threatEventDatasetNewResponseJSON `json:"-"`
}
func (*ThreatEventDatasetNewResponse) UnmarshalJSON ¶
func (r *ThreatEventDatasetNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventDatasetRawResponse ¶
type ThreatEventDatasetRawResponse struct {
ID float64 `json:"id" api:"required"`
AccountID float64 `json:"accountId" api:"required"`
Created string `json:"created" api:"required"`
Data string `json:"data" api:"required"`
Source string `json:"source" api:"required"`
TLP string `json:"tlp" api:"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
Events *ThreatEventDatasetEventService
}
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) Delete ¶ added in v7.8.0
func (r *ThreatEventDatasetService) Delete(ctx context.Context, datasetID string, body ThreatEventDatasetDeleteParams, opts ...option.RequestOption) (res *ThreatEventDatasetDeleteResponse, err error)
Soft-deletes a dataset given a datasetId.
func (*ThreatEventDatasetService) Edit ¶
func (r *ThreatEventDatasetService) Edit(ctx context.Context, datasetID string, params ThreatEventDatasetEditParams, opts ...option.RequestOption) (res *ThreatEventDatasetEditResponse, err error)
Partially updates a threat event dataset in Cloudforce One, modifying specific fields without replacing the entire dataset configuration.
func (*ThreatEventDatasetService) Get ¶
func (r *ThreatEventDatasetService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetGetResponse, err error)
Retrieves details for a specific threat event dataset.
func (*ThreatEventDatasetService) List ¶
func (r *ThreatEventDatasetService) List(ctx context.Context, params ThreatEventDatasetListParams, opts ...option.RequestOption) (res *[]ThreatEventDatasetListResponse, err error)
Lists all threat event datasets configured in Cloudforce One.
func (*ThreatEventDatasetService) New ¶
func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventDatasetNewParams, opts ...option.RequestOption) (res *ThreatEventDatasetNewResponse, err error)
Creates a new threat event dataset in Cloudforce One for organizing related threat events.
func (*ThreatEventDatasetService) Raw ¶
func (r *ThreatEventDatasetService) Raw(ctx context.Context, datasetID string, eventID string, query ThreatEventDatasetRawParams, opts ...option.RequestOption) (res *ThreatEventDatasetRawResponse, err error)
Retrieves the raw data associated with an event. Searches across all shards in the dataset.
type ThreatEventEditParams ¶
type ThreatEventEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Dataset ID containing the event to update.
DatasetID param.Field[string] `json:"datasetId" api:"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"`
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" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"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" api:"required"`
JSON threatEventEventTagDeleteResponseJSON `json:"-"`
}
func (*ThreatEventEventTagDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventEventTagDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagDeleteResponseEnvelope ¶
type ThreatEventEventTagDeleteResponseEnvelope struct {
Result ThreatEventEventTagDeleteResponse `json:"result" api:"required"`
Success bool `json:"success" api:"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" api:"required"`
Tags param.Field[[]string] `json:"tags" api:"required"`
}
func (ThreatEventEventTagNewParams) MarshalJSON ¶
func (r ThreatEventEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventEventTagNewResponse ¶
type ThreatEventEventTagNewResponse struct {
Success bool `json:"success" api:"required"`
JSON threatEventEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventEventTagNewResponse) UnmarshalJSON ¶
func (r *ThreatEventEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventEventTagNewResponseEnvelope ¶
type ThreatEventEventTagNewResponseEnvelope struct {
Result ThreatEventEventTagNewResponse `json:"result" api:"required"`
Success bool `json:"success" api:"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 a threat event in Cloudforce One.
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 a threat event in Cloudforce One for classification and filtering.
type ThreatEventGetParams ¶
type ThreatEventGetResponse ¶
type ThreatEventGetResponse struct {
Attacker string `json:"attacker" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventGetResponseJSON `json:"-"`
}
func (*ThreatEventGetResponse) UnmarshalJSON ¶
func (r *ThreatEventGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphListParams ¶ added in v7.8.0
type ThreatEventGraphListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Opaque pagination token. Only valid when seeds has exactly 1 entry; 400
// otherwise.
Cursor param.Field[string] `query:"cursor"`
// Comma-separated dataset UUIDs to restrict neighbor scope. Intersected with ACL
// grants.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
// Edge direction relative to each seed: out (seed→neighbors), in (neighbors→seed),
// both (default).
Direction param.Field[string] `query:"direction"`
// Comma-separated list of response sections to expand (hydrate). Allowed: `nodes`.
// Omitting `expand` returns identifier-only nodes.
Expand param.Field[[]string] `query:"expand"`
// Hydration strategy for neighbor nodes when expand=nodes is set. r2_join
// (default): use R2 JOIN query + DO fallback. do_only: use plain R2 query +
// hydrate all neighbors via Durable Objects.
Hydration param.Field[string] `query:"hydration"`
// Max neighbors per seed (default: 100, max: 1000). Values above 1000 return 400.
Limit param.Field[float64] `query:"limit"`
// Total accumulated node cap across all seeds (default: 500, max: 1000). Values
// above 1000 return 400.
MaxNodes param.Field[float64] `query:"max_nodes"`
// Comma-separated relationship types to filter by. Allowed: tagged_with,
// appears_in, related_to, caused_by, attributed_to.
RelationshipTypes param.Field[[]string] `query:"relationshipTypes"`
// Comma-separated compact seed ids (type:uuid). Example:
// seeds=event:550e8400-...,indicator:661fa920-... Provide 1–50 entries; omitting
// seeds returns 400.
Seeds param.Field[[]string] `query:"seeds"`
}
func (ThreatEventGraphListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventGraphListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventGraphListParams's query parameters as `url.Values`.
type ThreatEventGraphListResponse ¶ added in v7.8.0
type ThreatEventGraphListResponse struct {
Edges []ThreatEventGraphListResponseEdge `json:"edges" api:"required"`
// Focal node object (legacy single-seed). Null when unavailable.
Node map[string]interface{} `json:"node" api:"required,nullable"`
Nodes []map[string]interface{} `json:"nodes" api:"required"`
JSON threatEventGraphListResponseJSON `json:"-"`
}
func (*ThreatEventGraphListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventGraphListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphListResponseEdge ¶ added in v7.8.0
type ThreatEventGraphListResponseEdge struct {
// Deterministic composite edge id (source→target:relationshipType)
ID string `json:"id" api:"required"`
RelationshipType string `json:"relationshipType" api:"required"`
// Compact id of the source node (type:uuid)
Source string `json:"source" api:"required"`
SourceID string `json:"sourceId" api:"required"`
SourceType string `json:"sourceType" api:"required"`
// Compact id of the target node (type:uuid)
Target string `json:"target" api:"required"`
TargetID string `json:"targetId" api:"required"`
TargetType string `json:"targetType" api:"required"`
JSON threatEventGraphListResponseEdgeJSON `json:"-"`
}
func (*ThreatEventGraphListResponseEdge) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventGraphListResponseEdge) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphListResponseEnvelope ¶ added in v7.8.0
type ThreatEventGraphListResponseEnvelope struct {
Errors []map[string]interface{} `json:"errors" api:"required"`
Messages []map[string]interface{} `json:"messages" api:"required"`
Result ThreatEventGraphListResponse `json:"result" api:"required"`
Success bool `json:"success" api:"required"`
ResultInfo ThreatEventGraphListResponseEnvelopeResultInfo `json:"result_info"`
JSON threatEventGraphListResponseEnvelopeJSON `json:"-"`
}
func (*ThreatEventGraphListResponseEnvelope) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventGraphListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphListResponseEnvelopeResultInfo ¶ added in v7.8.0
type ThreatEventGraphListResponseEnvelopeResultInfo struct {
// Number of nodes in result.nodes (seeds + neighbors)
Count float64 `json:"count" api:"required"`
// Number of edges in result.edges
EdgeCount float64 `json:"edge_count" api:"required"`
// Total query time in milliseconds
QueryTimeMs float64 `json:"query_time_ms" api:"required"`
// Total count of nodes (same as count for this endpoint)
TotalCount float64 `json:"total_count" api:"required"`
// Opaque pagination cursor for the next page; null when exhausted or for
// multi-seed requests (single-seed only)
Cursor string `json:"cursor" api:"nullable"`
// Traversal depth reached (always 1 for single-level)
DepthReached float64 `json:"depth_reached"`
// True when a cursor is available for the next page (single-seed only)
HasMore bool `json:"has_more"`
// Composite ids of the seed node(s) (type:uuid). Always an array, even for one
// seed.
Seeds []string `json:"seeds"`
// True when results were capped (per-seed limit or max_nodes)
Truncated bool `json:"truncated"`
JSON threatEventGraphListResponseEnvelopeResultInfoJSON `json:"-"`
}
func (*ThreatEventGraphListResponseEnvelopeResultInfo) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventGraphListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphService ¶ added in v7.8.0
type ThreatEventGraphService struct {
Options []option.RequestOption
}
ThreatEventGraphService 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 NewThreatEventGraphService method instead.
func NewThreatEventGraphService ¶ added in v7.8.0
func NewThreatEventGraphService(opts ...option.RequestOption) (r *ThreatEventGraphService)
NewThreatEventGraphService 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 (*ThreatEventGraphService) List ¶ added in v7.8.0
func (r *ThreatEventGraphService) List(ctx context.Context, params ThreatEventGraphListParams, opts ...option.RequestOption) (res *ThreatEventGraphListResponse, err error)
Expands the single-level relationship neighborhood of one or more seed nodes (event, indicator, or tag) from R2 Data Catalog. Seeds use compact id format (type:uuid), e.g. "event:550e8400-...". Multi-seed requests merge and deduplicate results server-side. Hydrates neighbor entities with summary data from Durable Objects. Supports filtering by relationship type and dataset scope.
type ThreatEventGraphqlNewParams ¶ added in v7.8.0
type ThreatEventGraphqlNewResponse ¶ added in v7.8.0
type ThreatEventGraphqlNewResponse struct {
Data interface{} `json:"data" api:"nullable"`
Errors []interface{} `json:"errors" api:"nullable"`
JSON threatEventGraphqlNewResponseJSON `json:"-"`
}
func (*ThreatEventGraphqlNewResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventGraphqlNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventGraphqlService ¶ added in v7.8.0
type ThreatEventGraphqlService struct {
Options []option.RequestOption
}
ThreatEventGraphqlService 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 NewThreatEventGraphqlService method instead.
func NewThreatEventGraphqlService ¶ added in v7.8.0
func NewThreatEventGraphqlService(opts ...option.RequestOption) (r *ThreatEventGraphqlService)
NewThreatEventGraphqlService 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 (*ThreatEventGraphqlService) New ¶ added in v7.8.0
func (r *ThreatEventGraphqlService) New(ctx context.Context, body ThreatEventGraphqlNewParams, opts ...option.RequestOption) (res *ThreatEventGraphqlNewResponse, err error)
Execute GraphQL aggregations over threat events. Supports multi-dimensional group-bys, optional date range filtering, and multi-dataset aggregation.
type ThreatEventIndicatorAggregateListParams ¶ added in v7.8.0
type ThreatEventIndicatorAggregateListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Column(s) to aggregate by - single column or comma-separated list (e.g.,
// 'indicatorType', 'value', 'indicatorType,value')
AggregateBy param.Field[string] `query:"aggregateBy" api:"required"`
// Filter indicators created after this date/datetime (ISO 8601, e.g., '2024-01-01'
// or '2024-01-01T00:00:00Z')
CreatedAfter param.Field[ThreatEventIndicatorAggregateListParamsCreatedAfterUnion] `query:"createdAfter" format:"date-time"`
// Filter indicators created before this date/datetime (ISO 8601, e.g.,
// '2024-12-31' or '2024-12-31T23:59:59Z')
CreatedBefore param.Field[ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion] `query:"createdBefore" format:"date-time"`
// Dataset ID(s) to filter by. Can be a single dataset ID or comma-separated list.
// If not provided, aggregates across all accessible datasets
DatasetIDs param.Field[[]string] `query:"datasetIds"`
// For measure=relationships: only count event links whose eventDate is on/after
// this date (ISO 8601). Use to bound 'top indicator' to recent activity.
EventDateAfter param.Field[string] `query:"eventDateAfter"`
// For measure=relationships: only count event links whose eventDate is on/before
// this date (ISO 8601).
EventDateBefore param.Field[string] `query:"eventDateBefore"`
// Maximum number of aggregation results to return (1-100)
Limit param.Field[float64] `query:"limit"`
// What to count per group: 'indicators' (catalog rows, default) or 'relationships'
// (linked events per indicator). Use 'relationships' for 'top indicator by event
// activity'.
Measure param.Field[ThreatEventIndicatorAggregateListParamsMeasure] `query:"measure"`
// Scope to indicators associated with this tag/actor UUID. Combine with
// measure=relationships for 'top indicator for an actor'.
TagUUID param.Field[string] `query:"tagUuid"`
}
func (ThreatEventIndicatorAggregateListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorAggregateListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorAggregateListParams's query parameters as `url.Values`.
type ThreatEventIndicatorAggregateListParamsCreatedAfterUnion ¶ added in v7.9.0
type ThreatEventIndicatorAggregateListParamsCreatedAfterUnion interface {
ImplementsThreatEventIndicatorAggregateListParamsCreatedAfterUnion()
}
Filter indicators created after this date/datetime (ISO 8601, e.g., '2024-01-01' or '2024-01-01T00:00:00Z')
Satisfied by shared.UnionTime, shared.UnionString.
type ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion ¶ added in v7.9.0
type ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion interface {
ImplementsThreatEventIndicatorAggregateListParamsCreatedBeforeUnion()
}
Filter indicators created before this date/datetime (ISO 8601, e.g., '2024-12-31' or '2024-12-31T23:59:59Z')
Satisfied by shared.UnionTime, shared.UnionString.
type ThreatEventIndicatorAggregateListParamsMeasure ¶ added in v7.8.0
type ThreatEventIndicatorAggregateListParamsMeasure string
What to count per group: 'indicators' (catalog rows, default) or 'relationships' (linked events per indicator). Use 'relationships' for 'top indicator by event activity'.
const ( ThreatEventIndicatorAggregateListParamsMeasureIndicators ThreatEventIndicatorAggregateListParamsMeasure = "indicators" ThreatEventIndicatorAggregateListParamsMeasureRelationships ThreatEventIndicatorAggregateListParamsMeasure = "relationships" )
func (ThreatEventIndicatorAggregateListParamsMeasure) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorAggregateListParamsMeasure) IsKnown() bool
type ThreatEventIndicatorAggregateListResponse ¶ added in v7.8.0
type ThreatEventIndicatorAggregateListResponse struct {
// Column(s) that were aggregated by
AggregateBy string `json:"aggregateBy" api:"required"`
// Array of aggregation results with dynamic fields based on aggregateBy columns
Aggregations []ThreatEventIndicatorAggregateListResponseAggregation `json:"aggregations" api:"required"`
// Number of datasets whose aggregation failed and were excluded from the result
FailedDatasets float64 `json:"failedDatasets" api:"required"`
// Total count in the aggregation: indicator rows when measure=indicators, or
// linked-event rows when measure=relationships
Total float64 `json:"total" api:"required"`
JSON threatEventIndicatorAggregateListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorAggregateListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorAggregateListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorAggregateListResponseAggregation ¶ added in v7.8.0
type ThreatEventIndicatorAggregateListResponseAggregation struct {
// Number of indicators for this aggregation
Count float64 `json:"count" api:"required"`
ExtraFields map[string]string `json:"-" api:"extrafields"`
JSON threatEventIndicatorAggregateListResponseAggregationJSON `json:"-"`
}
func (*ThreatEventIndicatorAggregateListResponseAggregation) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorAggregateListResponseAggregation) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorAggregateService ¶ added in v7.8.0
type ThreatEventIndicatorAggregateService struct {
Options []option.RequestOption
}
ThreatEventIndicatorAggregateService 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 NewThreatEventIndicatorAggregateService method instead.
func NewThreatEventIndicatorAggregateService ¶ added in v7.8.0
func NewThreatEventIndicatorAggregateService(opts ...option.RequestOption) (r *ThreatEventIndicatorAggregateService)
NewThreatEventIndicatorAggregateService 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 (*ThreatEventIndicatorAggregateService) List ¶ added in v7.8.0
func (r *ThreatEventIndicatorAggregateService) List(ctx context.Context, params ThreatEventIndicatorAggregateListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorAggregateListResponse, err error)
Aggregate threat indicators by one or more columns (e.g., indicatorType, value) across datasets. Returns top-N groups ordered by count.
type ThreatEventIndicatorByDatasetGetParams ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetGetResponse ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetGetResponse struct {
CreatedAt time.Time `json:"createdAt" api:"required" format:"date-time"`
IndicatorType string `json:"indicatorType" api:"required"`
UpdatedAt time.Time `json:"updatedAt" api:"required" format:"date-time"`
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
// The dataset ID this indicator belongs to. Included in list responses.
DatasetID string `json:"datasetId"`
RelatedEvents []ThreatEventIndicatorByDatasetGetResponseRelatedEvent `json:"relatedEvents"`
Tags []ThreatEventIndicatorByDatasetGetResponseTag `json:"tags"`
JSON threatEventIndicatorByDatasetGetResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetGetResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetGetResponseRelatedEvent ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetGetResponseRelatedEvent struct {
DatasetID string `json:"datasetId" api:"required"`
EventID string `json:"eventId" api:"required"`
// ISO 8601 date of the related event. Null for legacy relationships created before
// event-date tracking was added.
EventDate string `json:"eventDate" api:"nullable"`
JSON threatEventIndicatorByDatasetGetResponseRelatedEventJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetGetResponseRelatedEvent) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetGetResponseRelatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetGetResponseTag ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetGetResponseTag struct {
CategoryName string `json:"categoryName"`
UUID string `json:"uuid"`
Value string `json:"value"`
JSON threatEventIndicatorByDatasetGetResponseTagJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetGetResponseTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetGetResponseTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetListParams ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
IndicatorType param.Field[string] `query:"indicatorType"`
// Filter by indicator value (substring match)
Name param.Field[string] `query:"name"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
// repeating the parameter.
RelatedEvent param.Field[[]string] `query:"relatedEvent"`
}
func (ThreatEventIndicatorByDatasetListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorByDatasetListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorByDatasetListParams's query parameters as `url.Values`.
type ThreatEventIndicatorByDatasetListResponse ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListResponse struct {
Indicators []ThreatEventIndicatorByDatasetListResponseIndicator `json:"indicators" api:"required"`
Pagination ThreatEventIndicatorByDatasetListResponsePagination `json:"pagination" api:"required"`
JSON threatEventIndicatorByDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetListResponseIndicator ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListResponseIndicator struct {
CreatedAt time.Time `json:"createdAt" api:"required" format:"date-time"`
IndicatorType string `json:"indicatorType" api:"required"`
UpdatedAt time.Time `json:"updatedAt" api:"required" format:"date-time"`
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
// The dataset ID this indicator belongs to. Included in list responses.
DatasetID string `json:"datasetId"`
RelatedEvents []ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
Tags []ThreatEventIndicatorByDatasetListResponseIndicatorsTag `json:"tags"`
JSON threatEventIndicatorByDatasetListResponseIndicatorJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetListResponseIndicator) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetListResponseIndicator) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent struct {
DatasetID string `json:"datasetId" api:"required"`
EventID string `json:"eventId" api:"required"`
// ISO 8601 date of the related event. Null for legacy relationships created before
// event-date tracking was added.
EventDate string `json:"eventDate" api:"nullable"`
JSON threatEventIndicatorByDatasetListResponseIndicatorsRelatedEventJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetListResponseIndicatorsTag ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListResponseIndicatorsTag struct {
CategoryName string `json:"categoryName"`
UUID string `json:"uuid"`
Value string `json:"value"`
JSON threatEventIndicatorByDatasetListResponseIndicatorsTagJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetListResponsePagination ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetListResponsePagination struct {
Page float64 `json:"page" api:"required"`
PageSize float64 `json:"pageSize" api:"required"`
TotalCount float64 `json:"totalCount" api:"required"`
TotalPages float64 `json:"totalPages" api:"required"`
JSON threatEventIndicatorByDatasetListResponsePaginationJSON `json:"-"`
}
func (*ThreatEventIndicatorByDatasetListResponsePagination) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetListResponsePagination) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorByDatasetService ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetService struct {
Options []option.RequestOption
Tags *ThreatEventIndicatorByDatasetTagService
}
ThreatEventIndicatorByDatasetService 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 NewThreatEventIndicatorByDatasetService method instead.
func NewThreatEventIndicatorByDatasetService ¶ added in v7.8.0
func NewThreatEventIndicatorByDatasetService(opts ...option.RequestOption) (r *ThreatEventIndicatorByDatasetService)
NewThreatEventIndicatorByDatasetService 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 (*ThreatEventIndicatorByDatasetService) Get ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetService) Get(ctx context.Context, datasetID string, indicatorID string, query ThreatEventIndicatorByDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventIndicatorByDatasetGetResponse, err error)
Retrieves a specific indicator by its UUID.
func (*ThreatEventIndicatorByDatasetService) List
deprecated
added in
v7.8.0
func (r *ThreatEventIndicatorByDatasetService) List(ctx context.Context, datasetID string, params ThreatEventIndicatorByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorByDatasetListResponse, err error)
This method is deprecated. Please use /events/indicators to retrieve a paginated list of indicators.
Deprecated: Use indicators.list instead (GET /accounts/{account_id}/cloudforce-one/events/indicators).
type ThreatEventIndicatorByDatasetTagListParams ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetTagListResponse ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetTagListResponse = interface{}
type ThreatEventIndicatorByDatasetTagService ¶ added in v7.8.0
type ThreatEventIndicatorByDatasetTagService struct {
Options []option.RequestOption
}
ThreatEventIndicatorByDatasetTagService 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 NewThreatEventIndicatorByDatasetTagService method instead.
func NewThreatEventIndicatorByDatasetTagService ¶ added in v7.8.0
func NewThreatEventIndicatorByDatasetTagService(opts ...option.RequestOption) (r *ThreatEventIndicatorByDatasetTagService)
NewThreatEventIndicatorByDatasetTagService 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 (*ThreatEventIndicatorByDatasetTagService) List ¶ added in v7.8.0
func (r *ThreatEventIndicatorByDatasetTagService) List(ctx context.Context, datasetID string, query ThreatEventIndicatorByDatasetTagListParams, opts ...option.RequestOption) (res *[]ThreatEventIndicatorByDatasetTagListResponse, err error)
Returns all mirrored tags from the indicator dataset (DO mirror table). No pagination.
type ThreatEventIndicatorListParams ¶ added in v7.8.0
type ThreatEventIndicatorListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
// Cannot be combined with `cursor`.
Cache param.Field[ThreatEventIndicatorListParamsCache] `query:"cache"`
// Filter indicators created on or after this date. Must use ISO 8601 format (e.g.,
// '2024-01-15T00:00:00Z').
CreatedAfter param.Field[time.Time] `query:"createdAfter" format:"date-time"`
// Filter indicators created on or before this date. Must use ISO 8601 format
// (e.g., '2024-12-31T23:59:59Z').
CreatedBefore param.Field[time.Time] `query:"createdBefore" format:"date-time"`
// Opaque cursor from a previous response's `pagination.cursor`. When provided, all
// filters, datasetIds, page, `pageSize`, `includeTags` and `relatedEventsLimit`
// come from the cursor — do not resend them. Sending any filter, `page`,
// `pageSize`, `includeTags`, `relatedEventsLimit`, `includeTotalCount=true`, or
// `cache=from-graph` alongside a cursor yields a 400 `CursorFilterConflictError`.
// A cursor issued for a different entity, an unsupported version, or a dataset
// that has since been reconfigured as analytics-only yields a 400
// `InvalidCursorError`.
Cursor param.Field[string] `query:"cursor"`
// Dataset IDs to query indicators from (array of UUIDs), or special value 'all' or
// '\*' to query all datasets. If not provided, uses the default dataset.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
// Output format for indicator data. 'json' returns the default format, 'stix2'
// returns STIX 2.1 Indicator SDOs, 'taxii' returns a TAXII 2.1 Envelope with
// Content-Type application/taxii+json;version=2.1.
Format param.Field[ThreatEventIndicatorListParamsFormat] `query:"format"`
// Whether to include full tag details for each indicator. Defaults to true.
IncludeTags param.Field[bool] `query:"includeTags"`
// Whether to compute total count via COUNT(\*). Defaults to false for performance.
// total_count is null unless this is true and the complete fan-out succeeds.
IncludeTotalCount param.Field[bool] `query:"includeTotalCount"`
IndicatorType param.Field[string] `query:"indicatorType"`
// Filter indicators by value using substring match (LIKE). Legacy alternative to
// structured search.
Name param.Field[string] `query:"name"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// Filter by related event IDs
RelatedEvents param.Field[[]string] `query:"relatedEvents"`
// Limit the number of related events returned per indicator. Default: 2. Set to 0
// for none, -1 for all events.
RelatedEventsLimit param.Field[float64] `query:"relatedEventsLimit"`
// Structured search as a JSON array of {field, op, value} objects. Searchable
// fields: value, indicatorType, uuid. Supports operators: equals, not, contains,
// startsWith, endsWith, gt, lt, gte, lte, like, in, find. Use the 'in' operator
// with an array value to bulk-check up to 100 indicators in a single request, e.g.
// search=[{"field":"value","op":"in","value":["evil.com","bad.org"]}]. Multiple
// conditions are AND'd together. Max 10 conditions per request.
Search param.Field[[]ThreatEventIndicatorListParamsSearch] `query:"search"`
// Filter by tag values or UUIDs. Indicators must have at least one of the
// specified tags (OR logic). Supports both tag UUID and tag value.
Tags param.Field[[]string] `query:"tags"`
// Structured tag-metadata filter as a JSON array of {field, op, value} objects.
// Operates against the per-dataset IndicatorTag mirror so you can find indicators
// by tag attributes (origin country, motive, sophistication, priority, etc.)
// without a separate Tags lookup. Common dashboard usage: drill from a country
// into indicators, e.g.
// tagSearch=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Country
// values may be passed as alpha-2, alpha-3, name, or alias (e.g. "iran").
// Operators: equals, not, gt/gte/lt/lte (numeric only),
// contains/like/find/startsWith/endsWith (string only), in. AND-joined across
// entries; combined with `tags`, a matching tag must satisfy both. Max 10 entries
// per request, max 100 values per 'in'. Performance notes: `originCountryISO` uses
// its B-tree index for equals/not/in. `priority` uses its B-tree index for numeric
// comparisons. Other string columns (`actorCategory`, `motive`, etc.) are
// case-insensitive and unindexed; current catalog size makes this a non-issue.
// `endsWith` and `aliasGroupNames` contains/like are leading-wildcard scans and
// slow on large result sets. `aliasGroupNames` matches on the JSON-encoded text,
// so substrings can cross alias boundaries ("apt28" also matches "apt280" when
// both appear in the same tag's alias list).
TagSearch param.Field[[]ThreatEventIndicatorListParamsTagSearch] `query:"tagSearch"`
}
func (ThreatEventIndicatorListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorListParams's query parameters as `url.Values`.
type ThreatEventIndicatorListParamsCache ¶ added in v7.8.0
type ThreatEventIndicatorListParamsCache string
Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. Cannot be combined with `cursor`.
const (
ThreatEventIndicatorListParamsCacheFromGraph ThreatEventIndicatorListParamsCache = "from-graph"
)
func (ThreatEventIndicatorListParamsCache) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsCache) IsKnown() bool
type ThreatEventIndicatorListParamsFormat ¶ added in v7.8.0
type ThreatEventIndicatorListParamsFormat string
Output format for indicator data. 'json' returns the default format, 'stix2' returns STIX 2.1 Indicator SDOs, 'taxii' returns a TAXII 2.1 Envelope with Content-Type application/taxii+json;version=2.1.
const ( ThreatEventIndicatorListParamsFormatJson ThreatEventIndicatorListParamsFormat = "json" ThreatEventIndicatorListParamsFormatStix2 ThreatEventIndicatorListParamsFormat = "stix2" ThreatEventIndicatorListParamsFormatTaxii ThreatEventIndicatorListParamsFormat = "taxii" )
func (ThreatEventIndicatorListParamsFormat) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsFormat) IsKnown() bool
type ThreatEventIndicatorListParamsSearch ¶ added in v7.8.0
type ThreatEventIndicatorListParamsSearch struct {
// The indicator field to search on. Allowed: value, indicatorType, uuid.
Field param.Field[ThreatEventIndicatorListParamsSearchField] `query:"field" api:"required"`
// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
// {field:'value', op:'in', value:['evil.com','bad.org']}.
Op param.Field[ThreatEventIndicatorListParamsSearchOp] `query:"op" api:"required"`
// Search value. String for most operators. Array of strings for 'in' operator (max
// 100 items).
Value param.Field[ThreatEventIndicatorListParamsSearchValueUnion] `query:"value" api:"required"`
}
func (ThreatEventIndicatorListParamsSearch) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorListParamsSearch's query parameters as `url.Values`.
type ThreatEventIndicatorListParamsSearchField ¶ added in v7.8.0
type ThreatEventIndicatorListParamsSearchField string
The indicator field to search on. Allowed: value, indicatorType, uuid.
const ( ThreatEventIndicatorListParamsSearchFieldValue ThreatEventIndicatorListParamsSearchField = "value" ThreatEventIndicatorListParamsSearchFieldIndicatorType ThreatEventIndicatorListParamsSearchField = "indicatorType" ThreatEventIndicatorListParamsSearchFieldUUID ThreatEventIndicatorListParamsSearchField = "uuid" )
func (ThreatEventIndicatorListParamsSearchField) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsSearchField) IsKnown() bool
type ThreatEventIndicatorListParamsSearchOp ¶ added in v7.8.0
type ThreatEventIndicatorListParamsSearchOp string
Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}.
const ( ThreatEventIndicatorListParamsSearchOpEquals ThreatEventIndicatorListParamsSearchOp = "equals" ThreatEventIndicatorListParamsSearchOpNot ThreatEventIndicatorListParamsSearchOp = "not" ThreatEventIndicatorListParamsSearchOpGt ThreatEventIndicatorListParamsSearchOp = "gt" ThreatEventIndicatorListParamsSearchOpGte ThreatEventIndicatorListParamsSearchOp = "gte" ThreatEventIndicatorListParamsSearchOpLt ThreatEventIndicatorListParamsSearchOp = "lt" ThreatEventIndicatorListParamsSearchOpLte ThreatEventIndicatorListParamsSearchOp = "lte" ThreatEventIndicatorListParamsSearchOpLike ThreatEventIndicatorListParamsSearchOp = "like" ThreatEventIndicatorListParamsSearchOpContains ThreatEventIndicatorListParamsSearchOp = "contains" ThreatEventIndicatorListParamsSearchOpStartsWith ThreatEventIndicatorListParamsSearchOp = "startsWith" ThreatEventIndicatorListParamsSearchOpEndsWith ThreatEventIndicatorListParamsSearchOp = "endsWith" ThreatEventIndicatorListParamsSearchOpIn ThreatEventIndicatorListParamsSearchOp = "in" ThreatEventIndicatorListParamsSearchOpFind ThreatEventIndicatorListParamsSearchOp = "find" )
func (ThreatEventIndicatorListParamsSearchOp) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsSearchOp) IsKnown() bool
type ThreatEventIndicatorListParamsSearchValueArray ¶ added in v7.8.0
type ThreatEventIndicatorListParamsSearchValueArray []string
func (ThreatEventIndicatorListParamsSearchValueArray) ImplementsThreatEventIndicatorListParamsSearchValueUnion ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsSearchValueArray) ImplementsThreatEventIndicatorListParamsSearchValueUnion()
type ThreatEventIndicatorListParamsSearchValueUnion ¶ added in v7.8.0
type ThreatEventIndicatorListParamsSearchValueUnion interface {
ImplementsThreatEventIndicatorListParamsSearchValueUnion()
}
Search value. String for most operators. Array of strings for 'in' operator (max 100 items).
Satisfied by shared.UnionString, cloudforce_one.ThreatEventIndicatorListParamsSearchValueArray.
type ThreatEventIndicatorListParamsTagSearch ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearch struct {
// Tag mirror field to filter on. Allowed: value, categoryId, actorCategory,
// aliasGroupNames, attributionConfidence, attributionOrganization, motive,
// opsecLevel, originCountryISO, sophisticationLevel, priority, analyticPriority.
// Filters operate against the per-dataset IndicatorTag mirror (which is kept in
// sync with the Tags SoT by the tag-propagation workflow).
Field param.Field[ThreatEventIndicatorListParamsTagSearchField] `query:"field" api:"required"`
// Search operator. Use 'in' for bulk OR within a single field, e.g.
// {field:"originCountryISO", op:"in", value:["IR","CN"]}.
Op param.Field[ThreatEventIndicatorListParamsTagSearchOp] `query:"op" api:"required"`
// Search value. String or number for most operators. Array for 'in' (max 100
// items). Country values may be passed as alpha-2, alpha-3, name, or common alias
// (e.g. "iran", "IR", "IRN") and are normalized to alpha-2 server-side.
Value param.Field[ThreatEventIndicatorListParamsTagSearchValueUnion] `query:"value"`
}
func (ThreatEventIndicatorListParamsTagSearch) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsTagSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorListParamsTagSearch's query parameters as `url.Values`.
type ThreatEventIndicatorListParamsTagSearchField ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearchField string
Tag mirror field to filter on. Allowed: value, categoryId, actorCategory, aliasGroupNames, attributionConfidence, attributionOrganization, motive, opsecLevel, originCountryISO, sophisticationLevel, priority, analyticPriority. Filters operate against the per-dataset IndicatorTag mirror (which is kept in sync with the Tags SoT by the tag-propagation workflow).
const ( ThreatEventIndicatorListParamsTagSearchFieldValue ThreatEventIndicatorListParamsTagSearchField = "value" ThreatEventIndicatorListParamsTagSearchFieldCategoryID ThreatEventIndicatorListParamsTagSearchField = "categoryId" ThreatEventIndicatorListParamsTagSearchFieldActorCategory ThreatEventIndicatorListParamsTagSearchField = "actorCategory" ThreatEventIndicatorListParamsTagSearchFieldAliasGroupNames ThreatEventIndicatorListParamsTagSearchField = "aliasGroupNames" ThreatEventIndicatorListParamsTagSearchFieldAttributionConfidence ThreatEventIndicatorListParamsTagSearchField = "attributionConfidence" ThreatEventIndicatorListParamsTagSearchFieldAttributionOrganization ThreatEventIndicatorListParamsTagSearchField = "attributionOrganization" ThreatEventIndicatorListParamsTagSearchFieldMotive ThreatEventIndicatorListParamsTagSearchField = "motive" ThreatEventIndicatorListParamsTagSearchFieldOpsecLevel ThreatEventIndicatorListParamsTagSearchField = "opsecLevel" ThreatEventIndicatorListParamsTagSearchFieldOriginCountryISO ThreatEventIndicatorListParamsTagSearchField = "originCountryISO" ThreatEventIndicatorListParamsTagSearchFieldSophisticationLevel ThreatEventIndicatorListParamsTagSearchField = "sophisticationLevel" ThreatEventIndicatorListParamsTagSearchFieldPriority ThreatEventIndicatorListParamsTagSearchField = "priority" ThreatEventIndicatorListParamsTagSearchFieldAnalyticPriority ThreatEventIndicatorListParamsTagSearchField = "analyticPriority" )
func (ThreatEventIndicatorListParamsTagSearchField) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsTagSearchField) IsKnown() bool
type ThreatEventIndicatorListParamsTagSearchOp ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearchOp string
Search operator. Use 'in' for bulk OR within a single field, e.g. {field:"originCountryISO", op:"in", value:["IR","CN"]}.
const ( ThreatEventIndicatorListParamsTagSearchOpEquals ThreatEventIndicatorListParamsTagSearchOp = "equals" ThreatEventIndicatorListParamsTagSearchOpNot ThreatEventIndicatorListParamsTagSearchOp = "not" ThreatEventIndicatorListParamsTagSearchOpGt ThreatEventIndicatorListParamsTagSearchOp = "gt" ThreatEventIndicatorListParamsTagSearchOpGte ThreatEventIndicatorListParamsTagSearchOp = "gte" ThreatEventIndicatorListParamsTagSearchOpLt ThreatEventIndicatorListParamsTagSearchOp = "lt" ThreatEventIndicatorListParamsTagSearchOpLte ThreatEventIndicatorListParamsTagSearchOp = "lte" ThreatEventIndicatorListParamsTagSearchOpLike ThreatEventIndicatorListParamsTagSearchOp = "like" ThreatEventIndicatorListParamsTagSearchOpContains ThreatEventIndicatorListParamsTagSearchOp = "contains" ThreatEventIndicatorListParamsTagSearchOpStartsWith ThreatEventIndicatorListParamsTagSearchOp = "startsWith" ThreatEventIndicatorListParamsTagSearchOpEndsWith ThreatEventIndicatorListParamsTagSearchOp = "endsWith" ThreatEventIndicatorListParamsTagSearchOpIn ThreatEventIndicatorListParamsTagSearchOp = "in" ThreatEventIndicatorListParamsTagSearchOpFind ThreatEventIndicatorListParamsTagSearchOp = "find" )
func (ThreatEventIndicatorListParamsTagSearchOp) IsKnown ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsTagSearchOp) IsKnown() bool
type ThreatEventIndicatorListParamsTagSearchValueArray ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearchValueArray []ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion
func (ThreatEventIndicatorListParamsTagSearchValueArray) ImplementsThreatEventIndicatorListParamsTagSearchValueUnion ¶ added in v7.8.0
func (r ThreatEventIndicatorListParamsTagSearchValueArray) ImplementsThreatEventIndicatorListParamsTagSearchValueUnion()
type ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion interface {
ImplementsThreatEventIndicatorListParamsTagSearchValueArrayItemUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type ThreatEventIndicatorListParamsTagSearchValueUnion ¶ added in v7.8.0
type ThreatEventIndicatorListParamsTagSearchValueUnion interface {
ImplementsThreatEventIndicatorListParamsTagSearchValueUnion()
}
Search value. String or number for most operators. Array for 'in' (max 100 items). Country values may be passed as alpha-2, alpha-3, name, or common alias (e.g. "iran", "IR", "IRN") and are normalized to alpha-2 server-side.
Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventIndicatorListParamsTagSearchValueArray.
type ThreatEventIndicatorListResponse ¶ added in v7.8.0
type ThreatEventIndicatorListResponse struct {
Properties ThreatEventIndicatorListResponseProperties `json:"properties" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponseProperties ¶ added in v7.8.0
type ThreatEventIndicatorListResponseProperties struct {
Completeness ThreatEventIndicatorListResponsePropertiesCompleteness `json:"completeness" api:"required"`
Indicators ThreatEventIndicatorListResponsePropertiesIndicators `json:"indicators" api:"required"`
Pagination ThreatEventIndicatorListResponsePropertiesPagination `json:"pagination" api:"required"`
JSON threatEventIndicatorListResponsePropertiesJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponseProperties) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponseProperties) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompleteness ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompleteness struct {
Properties ThreatEventIndicatorListResponsePropertiesCompletenessProperties `json:"properties" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompleteness) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompleteness) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessProperties ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessProperties struct {
Complete ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete `json:"complete" api:"required"`
FailedDatasets ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets `json:"failedDatasets" api:"required"`
FailedShards ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards `json:"failedShards" api:"required"`
Warnings ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings `json:"warnings" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessProperties) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessProperties) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesCompleteJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets struct {
Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards struct {
Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems struct {
Properties ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties `json:"properties" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties struct {
DatasetID ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID `json:"datasetId" api:"required"`
ShardID ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID `json:"shardId" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetIDJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardIDJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings struct {
Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesIndicators ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesIndicators struct {
Items ThreatEventIndicatorListResponsePropertiesIndicatorsItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesIndicatorsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesIndicators) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesIndicators) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesIndicatorsItems ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesIndicatorsItems struct {
CreatedAt time.Time `json:"createdAt" api:"required" format:"date-time"`
IndicatorType string `json:"indicatorType" api:"required"`
UpdatedAt time.Time `json:"updatedAt" api:"required" format:"date-time"`
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
// The dataset ID this indicator belongs to. Included in list responses.
DatasetID string `json:"datasetId"`
RelatedEvents []ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent `json:"relatedEvents"`
Tags []ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag `json:"tags"`
JSON threatEventIndicatorListResponsePropertiesIndicatorsItemsJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItems) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesIndicatorsItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent struct {
DatasetID string `json:"datasetId" api:"required"`
EventID string `json:"eventId" api:"required"`
// ISO 8601 date of the related event. Null for legacy relationships created before
// event-date tracking was added.
EventDate string `json:"eventDate" api:"nullable"`
JSON threatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEventJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag struct {
CategoryName string `json:"categoryName"`
UUID string `json:"uuid"`
Value string `json:"value"`
JSON threatEventIndicatorListResponsePropertiesIndicatorsItemsTagJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPagination ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPagination struct {
Properties ThreatEventIndicatorListResponsePropertiesPaginationProperties `json:"properties" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPagination) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPagination) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationProperties ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPaginationProperties struct {
Count ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount `json:"count" api:"required"`
Cursor ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor `json:"cursor" api:"required"`
HasMore ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore `json:"has_more" api:"required"`
Page ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage `json:"page" api:"required"`
PerPage ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage `json:"per_page" api:"required"`
TotalCount ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount `json:"total_count" api:"required"`
TotalCountIsExact ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact `json:"total_count_is_exact" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationProperties) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationProperties) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesCountJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor struct {
Description string `json:"description" api:"required"`
Nullable bool `json:"nullable" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesCursorJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore struct {
Description string `json:"description" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesHasMoreJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesPageJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage struct {
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesPerPageJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount ¶ added in v7.8.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount struct {
Description string `json:"description" api:"required"`
Nullable bool `json:"nullable" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact ¶ added in v7.9.0
type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact struct {
Description string `json:"description" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExactJSON `json:"-"`
}
func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact) UnmarshalJSON ¶ added in v7.9.0
func (r *ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorService ¶ added in v7.8.0
type ThreatEventIndicatorService struct {
Options []option.RequestOption
Aggregate *ThreatEventIndicatorAggregateService
Types *ThreatEventIndicatorTypeService
ByDataset *ThreatEventIndicatorByDatasetService
}
ThreatEventIndicatorService 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 NewThreatEventIndicatorService method instead.
func NewThreatEventIndicatorService ¶ added in v7.8.0
func NewThreatEventIndicatorService(opts ...option.RequestOption) (r *ThreatEventIndicatorService)
NewThreatEventIndicatorService 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 (*ThreatEventIndicatorService) List ¶ added in v7.8.0
func (r *ThreatEventIndicatorService) List(ctx context.Context, params ThreatEventIndicatorListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorListResponse, err error)
Retrieves indicators across specified datasets, ordered by createdAt descending then UUID, dataset ID, and shard ID ascending. Use datasetIds=all or datasetIds=\* to query all datasets for the account. If no datasetIds provided, uses the default dataset.
type ThreatEventIndicatorTypeListParams ¶
type ThreatEventIndicatorTypeListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Array of dataset IDs to query indicator types from. If not provided, queries all
// datasets for the account.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
}
func (ThreatEventIndicatorTypeListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventIndicatorTypeListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventIndicatorTypeListParams's query parameters as `url.Values`.
type ThreatEventIndicatorTypeListResponse ¶
type ThreatEventIndicatorTypeListResponse struct {
Items ThreatEventIndicatorTypeListResponseItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventIndicatorTypeListResponseJSON `json:"-"`
}
func (*ThreatEventIndicatorTypeListResponse) UnmarshalJSON ¶
func (r *ThreatEventIndicatorTypeListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventIndicatorTypeListResponseItems ¶
type ThreatEventIndicatorTypeListResponseItems struct {
Type string `json:"type" api:"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 ¶
func (r *ThreatEventIndicatorTypeService) List(ctx context.Context, params ThreatEventIndicatorTypeListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorTypeListResponse, err error)
Lists indicator types across multiple datasets
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" api:"required"`
// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
Cache param.Field[ThreatEventListParamsCache] `query:"cache"`
// Cursor for pagination. When provided, filters are embedded in the cursor so you
// only need to pass cursor and pageSize. Returned in the previous response's
// result_info.cursor field. Use cursor-based pagination for deep pagination
// (beyond 100,000 records) or for optimal performance.
Cursor param.Field[string] `query:"cursor"`
// Dataset IDs to query events from (array of UUIDs), or special value 'all' or
// '\*' to query all event datasets for the account. If not provided, uses the
// default dataset.
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 number (1-indexed) for offset-based pagination. Limited to offset of
// 100,000 records. For deep pagination, use cursor-based pagination instead.
Page param.Field[float64] `query:"page"`
// Number of results per page. Maximum 25,000.
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 ThreatEventListParamsCache ¶ added in v7.8.0
type ThreatEventListParamsCache string
Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit.
const (
ThreatEventListParamsCacheFromGraph ThreatEventListParamsCache = "from-graph"
)
func (ThreatEventListParamsCache) IsKnown ¶ added in v7.8.0
func (r ThreatEventListParamsCache) IsKnown() bool
type ThreatEventListParamsFormat ¶
type ThreatEventListParamsFormat string
const ( ThreatEventListParamsFormatJson ThreatEventListParamsFormat = "json" ThreatEventListParamsFormatStix2 ThreatEventListParamsFormat = "stix2" ThreatEventListParamsFormatTaxii ThreatEventListParamsFormat = "taxii" )
func (ThreatEventListParamsFormat) IsKnown ¶
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 {
// Event field to search on. Allowed: attacker, attackerCountry, category,
// createdAt, date, event, indicator, indicatorType, killChain, mitreAttack, tags,
// targetCountry, targetIndustry, tlp, uuid.
Field param.Field[string] `query:"field"`
// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
// {field:'tags', op:'in', value:['malware','apt']}.
Op param.Field[ThreatEventListParamsSearchOp] `query:"op"`
// Search value. String or number for most operators. Array for 'in' operator (max
// 100 items).
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
Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'tags', op:'in', value:['malware','apt']}.
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()
}
Search value. String or number for most operators. Array for 'in' operator (max 100 items).
Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventListParamsSearchValueArray.
type ThreatEventListResponse ¶
type ThreatEventListResponse struct {
Attacker string `json:"attacker" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"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" api:"required"`
Category param.Field[string] `json:"category" api:"required"`
Date param.Field[time.Time] `json:"date" api:"required" format:"date-time"`
Event param.Field[string] `json:"event" api:"required"`
Raw param.Field[ThreatEventNewParamsRaw] `json:"raw" api:"required"`
TLP param.Field[string] `json:"tlp" api:"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"`
}
func (ThreatEventNewParams) MarshalJSON ¶
func (r ThreatEventNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventNewParamsIndicator ¶
type ThreatEventNewParamsIndicator struct {
// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
// The indicator value (e.g., domain name, IP address, hash)
Value param.Field[string] `json:"value" api:"required"`
}
func (ThreatEventNewParamsIndicator) MarshalJSON ¶
func (r ThreatEventNewParamsIndicator) MarshalJSON() (data []byte, err error)
type ThreatEventNewParamsRaw ¶
type ThreatEventNewParamsRaw struct {
Data param.Field[map[string]interface{}] `json:"data" api:"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" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventNewResponseJSON `json:"-"`
}
func (*ThreatEventNewResponse) UnmarshalJSON ¶
func (r *ThreatEventNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventQueryDeleteParams ¶ added in v7.8.0
type ThreatEventQueryEditParams ¶ added in v7.8.0
type ThreatEventQueryEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Enable alerts for this query
AlertEnabled param.Field[bool] `json:"alert_enabled"`
// Enable alert rollup for this query
AlertRollupEnabled param.Field[bool] `json:"alert_rollup_enabled"`
// Unique name for the saved query
Name param.Field[string] `json:"name"`
// JSON string containing the query parameters
QueryJson param.Field[string] `json:"query_json"`
// Enable rule for this query
RuleEnabled param.Field[bool] `json:"rule_enabled"`
// Scope for the rule
RuleScope param.Field[string] `json:"rule_scope"`
}
func (ThreatEventQueryEditParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventQueryEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventQueryEditResponse ¶ added in v7.8.0
type ThreatEventQueryEditResponse struct {
// Unique identifier for the saved query
ID int64 `json:"id" api:"required"`
// Account ID
AccountID int64 `json:"account_id" api:"required"`
// Whether alerts are enabled
AlertEnabled bool `json:"alert_enabled" api:"required"`
// Whether alert rollup is enabled
AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
// Creation timestamp
CreatedAt string `json:"created_at" api:"required"`
// Name of the saved query
Name string `json:"name" api:"required"`
// JSON string containing the query parameters
QueryJson string `json:"query_json" api:"required"`
// Whether rule is enabled
RuleEnabled bool `json:"rule_enabled" api:"required"`
// Last update timestamp
UpdatedAt string `json:"updated_at" api:"required"`
// Email of the user who created the query
UserEmail string `json:"user_email" api:"required"`
// Intel Indicator Feed ID (numeric)
CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
// WAF rules list ID for blocking
RuleListID string `json:"rule_list_id"`
// Scope for the rule
RuleScope string `json:"rule_scope"`
JSON threatEventQueryEditResponseJSON `json:"-"`
}
func (*ThreatEventQueryEditResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventQueryEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventQueryGetParams ¶ added in v7.8.0
type ThreatEventQueryGetResponse ¶ added in v7.8.0
type ThreatEventQueryGetResponse struct {
// Unique identifier for the saved query
ID int64 `json:"id" api:"required"`
// Account ID
AccountID int64 `json:"account_id" api:"required"`
// Whether alerts are enabled
AlertEnabled bool `json:"alert_enabled" api:"required"`
// Whether alert rollup is enabled
AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
// Creation timestamp
CreatedAt string `json:"created_at" api:"required"`
// Name of the saved query
Name string `json:"name" api:"required"`
// JSON string containing the query parameters
QueryJson string `json:"query_json" api:"required"`
// Whether rule is enabled
RuleEnabled bool `json:"rule_enabled" api:"required"`
// Last update timestamp
UpdatedAt string `json:"updated_at" api:"required"`
// Email of the user who created the query
UserEmail string `json:"user_email" api:"required"`
// Intel Indicator Feed ID (numeric)
CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
// WAF rules list ID for blocking
RuleListID string `json:"rule_list_id"`
// Scope for the rule
RuleScope string `json:"rule_scope"`
JSON threatEventQueryGetResponseJSON `json:"-"`
}
func (*ThreatEventQueryGetResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventQueryGetResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventQueryListParams ¶ added in v7.8.0
type ThreatEventQueryListResponse ¶ added in v7.8.0
type ThreatEventQueryListResponse struct {
// Unique identifier for the saved query
ID int64 `json:"id" api:"required"`
// Account ID
AccountID int64 `json:"account_id" api:"required"`
// Whether alerts are enabled
AlertEnabled bool `json:"alert_enabled" api:"required"`
// Whether alert rollup is enabled
AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
// Creation timestamp
CreatedAt string `json:"created_at" api:"required"`
// Name of the saved query
Name string `json:"name" api:"required"`
// JSON string containing the query parameters
QueryJson string `json:"query_json" api:"required"`
// Whether rule is enabled
RuleEnabled bool `json:"rule_enabled" api:"required"`
// Last update timestamp
UpdatedAt string `json:"updated_at" api:"required"`
// Email of the user who created the query
UserEmail string `json:"user_email" api:"required"`
// Intel Indicator Feed ID (numeric)
CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
// WAF rules list ID for blocking
RuleListID string `json:"rule_list_id"`
// Scope for the rule
RuleScope string `json:"rule_scope"`
JSON threatEventQueryListResponseJSON `json:"-"`
}
func (*ThreatEventQueryListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventQueryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventQueryNewParams ¶ added in v7.8.0
type ThreatEventQueryNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Enable alerts for this query
AlertEnabled param.Field[bool] `json:"alert_enabled" api:"required"`
// Enable alert rollup for this query
AlertRollupEnabled param.Field[bool] `json:"alert_rollup_enabled" api:"required"`
// Unique name for the saved query
Name param.Field[string] `json:"name" api:"required"`
// JSON string containing the query parameters
QueryJson param.Field[string] `json:"query_json" api:"required"`
// Enable rule for this query
RuleEnabled param.Field[bool] `json:"rule_enabled" api:"required"`
// Scope for the rule
RuleScope param.Field[string] `json:"rule_scope"`
}
func (ThreatEventQueryNewParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventQueryNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventQueryNewResponse ¶ added in v7.8.0
type ThreatEventQueryNewResponse struct {
// Unique identifier for the saved query
ID int64 `json:"id" api:"required"`
// Account ID
AccountID int64 `json:"account_id" api:"required"`
// Whether alerts are enabled
AlertEnabled bool `json:"alert_enabled" api:"required"`
// Whether alert rollup is enabled
AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
// Creation timestamp
CreatedAt string `json:"created_at" api:"required"`
// Name of the saved query
Name string `json:"name" api:"required"`
// JSON string containing the query parameters
QueryJson string `json:"query_json" api:"required"`
// Whether rule is enabled
RuleEnabled bool `json:"rule_enabled" api:"required"`
// Last update timestamp
UpdatedAt string `json:"updated_at" api:"required"`
// Email of the user who created the query
UserEmail string `json:"user_email" api:"required"`
// Intel Indicator Feed ID (numeric)
CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
// WAF rules list ID for blocking
RuleListID string `json:"rule_list_id"`
// Scope for the rule
RuleScope string `json:"rule_scope"`
JSON threatEventQueryNewResponseJSON `json:"-"`
}
func (*ThreatEventQueryNewResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventQueryNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventQueryService ¶ added in v7.8.0
type ThreatEventQueryService struct {
Options []option.RequestOption
}
ThreatEventQueryService 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 NewThreatEventQueryService method instead.
func NewThreatEventQueryService ¶ added in v7.8.0
func NewThreatEventQueryService(opts ...option.RequestOption) (r *ThreatEventQueryService)
NewThreatEventQueryService 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 (*ThreatEventQueryService) Delete ¶ added in v7.8.0
func (r *ThreatEventQueryService) Delete(ctx context.Context, queryID int64, body ThreatEventQueryDeleteParams, opts ...option.RequestOption) (err error)
Delete a saved event query by its ID
func (*ThreatEventQueryService) Edit ¶ added in v7.8.0
func (r *ThreatEventQueryService) Edit(ctx context.Context, queryID int64, params ThreatEventQueryEditParams, opts ...option.RequestOption) (res *ThreatEventQueryEditResponse, err error)
Update an existing saved event query by its ID
func (*ThreatEventQueryService) Get ¶ added in v7.8.0
func (r *ThreatEventQueryService) Get(ctx context.Context, queryID int64, query ThreatEventQueryGetParams, opts ...option.RequestOption) (res *ThreatEventQueryGetResponse, err error)
Retrieve a saved event query by its ID
func (*ThreatEventQueryService) List ¶ added in v7.8.0
func (r *ThreatEventQueryService) List(ctx context.Context, query ThreatEventQueryListParams, opts ...option.RequestOption) (res *[]ThreatEventQueryListResponse, err error)
Retrieve all saved event queries for the account
func (*ThreatEventQueryService) New ¶ added in v7.8.0
func (r *ThreatEventQueryService) New(ctx context.Context, params ThreatEventQueryNewParams, opts ...option.RequestOption) (res *ThreatEventQueryNewResponse, err error)
Create a new saved event query for the account
type ThreatEventRawEditParams ¶
type ThreatEventRawEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"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" api:"required"`
Data interface{} `json:"data" api:"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" api:"required"`
AccountID float64 `json:"accountId" api:"required"`
Created string `json:"created" api:"required"`
Data interface{} `json:"data" api:"required"`
Source string `json:"source" api:"required"`
TLP string `json:"tlp" api:"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)
Partially updates raw threat event data in Cloudforce One, modifying specific fields of the event.
func (*ThreatEventRawService) Get ¶
func (r *ThreatEventRawService) Get(ctx context.Context, eventID string, rawID string, query ThreatEventRawGetParams, opts ...option.RequestOption) (res *ThreatEventRawGetResponse, err error)
Retrieves raw threat event data for a specific event in Cloudforce One.
type ThreatEventRelateDeleteResponse ¶
type ThreatEventRelateDeleteResponse struct {
Success bool `json:"success" api:"required"`
JSON threatEventRelateDeleteResponseJSON `json:"-"`
}
func (*ThreatEventRelateDeleteResponse) UnmarshalJSON ¶
func (r *ThreatEventRelateDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelateDeleteResponseEnvelope ¶
type ThreatEventRelateDeleteResponseEnvelope struct {
Result ThreatEventRelateDeleteResponse `json:"result" api:"required"`
Success bool `json:"success" api:"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 a reference link between related threat events in Cloudforce One.
type ThreatEventRelationshipListParams ¶ added in v7.8.0
type ThreatEventRelationshipListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The dataset ID to search within.
DatasetID param.Field[string] `query:"datasetId" api:"required"`
// The direction to traverse the graph. Defaults to 'both' to search all.
Direction param.Field[ThreatEventRelationshipListParamsDirection] `query:"direction"`
// Whether to include the starting event in the results. Defaults to true.
IncludeParent param.Field[bool] `query:"includeParent"`
// An optional array of indicator type IDs to filter the results by.
IndicatorTypeIDs param.Field[[]string] `query:"indicatorTypeIds"`
// The maximum depth to traverse. Defaults to 5.
MaxDepth param.Field[float64] `query:"maxDepth"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// An optional array of relationship types to filter by.
RelationshipTypes param.Field[ThreatEventRelationshipListParamsRelationshipTypesUnion] `query:"relationshipTypes"`
}
func (ThreatEventRelationshipListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventRelationshipListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventRelationshipListParams's query parameters as `url.Values`.
type ThreatEventRelationshipListParamsDirection ¶ added in v7.8.0
type ThreatEventRelationshipListParamsDirection string
The direction to traverse the graph. Defaults to 'both' to search all.
const ( ThreatEventRelationshipListParamsDirectionAncestors ThreatEventRelationshipListParamsDirection = "ancestors" ThreatEventRelationshipListParamsDirectionDescendants ThreatEventRelationshipListParamsDirection = "descendants" ThreatEventRelationshipListParamsDirectionBoth ThreatEventRelationshipListParamsDirection = "both" )
func (ThreatEventRelationshipListParamsDirection) IsKnown ¶ added in v7.8.0
func (r ThreatEventRelationshipListParamsDirection) IsKnown() bool
type ThreatEventRelationshipListParamsRelationshipTypesArray ¶ added in v7.8.0
type ThreatEventRelationshipListParamsRelationshipTypesArray []string
func (ThreatEventRelationshipListParamsRelationshipTypesArray) ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion ¶ added in v7.8.0
func (r ThreatEventRelationshipListParamsRelationshipTypesArray) ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion()
type ThreatEventRelationshipListParamsRelationshipTypesUnion ¶ added in v7.8.0
type ThreatEventRelationshipListParamsRelationshipTypesUnion interface {
ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion()
}
An optional array of relationship types to filter by.
Satisfied by shared.UnionString, cloudforce_one.ThreatEventRelationshipListParamsRelationshipTypesArray.
type ThreatEventRelationshipListResponse ¶ added in v7.8.0
type ThreatEventRelationshipListResponse struct {
Attacker string `json:"attacker" api:"required"`
AttackerCountry string `json:"attackerCountry" api:"required"`
AttackerCountryAlpha3 string `json:"attackerCountryAlpha3" api:"required"`
Category string `json:"category" api:"required"`
DatasetID string `json:"datasetId" api:"required"`
Date string `json:"date" api:"required"`
Event string `json:"event" api:"required"`
HasChildren bool `json:"hasChildren" api:"required"`
Indicator string `json:"indicator" api:"required"`
IndicatorType string `json:"indicatorType" api:"required"`
IndicatorTypeID float64 `json:"indicatorTypeId" api:"required"`
KillChain float64 `json:"killChain" api:"required"`
MitreAttack []string `json:"mitreAttack" api:"required"`
MitreCapec []string `json:"mitreCapec" api:"required"`
NumReferenced float64 `json:"numReferenced" api:"required"`
NumReferences float64 `json:"numReferences" api:"required"`
RawID string `json:"rawId" api:"required"`
Referenced []string `json:"referenced" api:"required"`
ReferencedIDs []float64 `json:"referencedIds" api:"required"`
References []string `json:"references" api:"required"`
ReferencesIDs []float64 `json:"referencesIds" api:"required"`
Tags []string `json:"tags" api:"required"`
TargetCountry string `json:"targetCountry" api:"required"`
TargetCountryAlpha3 string `json:"targetCountryAlpha3" api:"required"`
TargetIndustry string `json:"targetIndustry" api:"required"`
TLP string `json:"tlp" api:"required"`
UUID string `json:"uuid" api:"required"`
Insight string `json:"insight"`
ReleasabilityID string `json:"releasabilityId"`
JSON threatEventRelationshipListResponseJSON `json:"-"`
}
func (*ThreatEventRelationshipListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventRelationshipListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventRelationshipService ¶ added in v7.8.0
type ThreatEventRelationshipService struct {
Options []option.RequestOption
}
ThreatEventRelationshipService 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 NewThreatEventRelationshipService method instead.
func NewThreatEventRelationshipService ¶ added in v7.8.0
func NewThreatEventRelationshipService(opts ...option.RequestOption) (r *ThreatEventRelationshipService)
NewThreatEventRelationshipService 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 (*ThreatEventRelationshipService) List ¶ added in v7.8.0
func (r *ThreatEventRelationshipService) List(ctx context.Context, eventID string, params ThreatEventRelationshipListParams, opts ...option.RequestOption) (res *[]ThreatEventRelationshipListResponse, err error)
The `event_id` must be defined (to list existing events (and their IDs), use the [`Filter and List Events`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/methods/list/) endpoint). Also, must provide query parameters.
type ThreatEventService ¶
type ThreatEventService struct {
Options []option.RequestOption
Aggregate *ThreatEventAggregateService
Graphql *ThreatEventGraphqlService
Graph *ThreatEventGraphService
Queries *ThreatEventQueryService
Relationships *ThreatEventRelationshipService
Indicators *ThreatEventIndicatorService
Attackers *ThreatEventAttackerService
Categories *ThreatEventCategoryService
Countries *ThreatEventCountryService
Crons *ThreatEventCronService
Datasets *ThreatEventDatasetService
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) BulkNewRelationships
deprecated
added in
v7.8.0
func (r *ThreatEventService) BulkNewRelationships(ctx context.Context, params ThreatEventBulkNewRelationshipsParams, opts ...option.RequestOption) (res *ThreatEventBulkNewRelationshipsResponse, err error)
This method is deprecated. Please use `event_create_bulk` instead
Deprecated: This endpoint is deprecated and will be removed in a future version.
func (*ThreatEventService) Edit ¶
func (r *ThreatEventService) Edit(ctx context.Context, eventID string, params ThreatEventEditParams, opts ...option.RequestOption) (res *ThreatEventEditResponse, err error)
Partially updates a threat event in Cloudforce One, modifying specific fields without replacing the entire 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: Use datasets.events.get instead (GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/events/{event_id}).
func (*ThreatEventService) List ¶
func (r *ThreatEventService) List(ctx context.Context, params ThreatEventListParams, opts ...option.RequestOption) (res *[]ThreatEventListResponse, err error)
Use `datasetId=all` or `datasetId=*` to query all event datasets for the account (limited to 50). When `datasetId` is unspecified, events are listed from the default Cloudforce One Threat Events dataset. To list existing datasets, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.
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 ThreatEventTagCategoryDeleteParams ¶ added in v7.8.0
type ThreatEventTagCategoryDeleteResponse ¶ added in v7.8.0
type ThreatEventTagCategoryDeleteResponse struct {
UUID string `json:"uuid" api:"required"`
JSON threatEventTagCategoryDeleteResponseJSON `json:"-"`
}
func (*ThreatEventTagCategoryDeleteResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagCategoryDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagCategoryEditParams ¶ added in v7.8.0
type ThreatEventTagCategoryEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Description param.Field[string] `json:"description"`
Name param.Field[string] `json:"name"`
}
func (ThreatEventTagCategoryEditParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagCategoryEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagCategoryEditResponse ¶ added in v7.8.0
type ThreatEventTagCategoryEditResponse struct {
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
CreatedAt string `json:"createdAt"`
Description string `json:"description"`
UpdatedAt string `json:"updatedAt"`
JSON threatEventTagCategoryEditResponseJSON `json:"-"`
}
func (*ThreatEventTagCategoryEditResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagCategoryEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagCategoryListParams ¶ added in v7.8.0
type ThreatEventTagCategoryListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Search param.Field[string] `query:"search"`
}
func (ThreatEventTagCategoryListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagCategoryListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagCategoryListParams's query parameters as `url.Values`.
type ThreatEventTagCategoryListResponse ¶ added in v7.8.0
type ThreatEventTagCategoryListResponse struct {
Categories []ThreatEventTagCategoryListResponseCategory `json:"categories" api:"required"`
JSON threatEventTagCategoryListResponseJSON `json:"-"`
}
func (*ThreatEventTagCategoryListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagCategoryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagCategoryListResponseCategory ¶ added in v7.8.0
type ThreatEventTagCategoryListResponseCategory struct {
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
CreatedAt string `json:"createdAt"`
Description string `json:"description"`
UpdatedAt string `json:"updatedAt"`
JSON threatEventTagCategoryListResponseCategoryJSON `json:"-"`
}
func (*ThreatEventTagCategoryListResponseCategory) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagCategoryListResponseCategory) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagCategoryNewParams ¶ added in v7.8.0
type ThreatEventTagCategoryNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Name param.Field[string] `json:"name" api:"required"`
Description param.Field[string] `json:"description"`
}
func (ThreatEventTagCategoryNewParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagCategoryNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagCategoryNewResponse ¶ added in v7.8.0
type ThreatEventTagCategoryNewResponse struct {
Name string `json:"name" api:"required"`
UUID string `json:"uuid" api:"required"`
CreatedAt string `json:"createdAt"`
Description string `json:"description"`
UpdatedAt string `json:"updatedAt"`
JSON threatEventTagCategoryNewResponseJSON `json:"-"`
}
func (*ThreatEventTagCategoryNewResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagCategoryNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagCategoryService ¶ added in v7.8.0
type ThreatEventTagCategoryService struct {
Options []option.RequestOption
}
ThreatEventTagCategoryService 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 NewThreatEventTagCategoryService method instead.
func NewThreatEventTagCategoryService ¶ added in v7.8.0
func NewThreatEventTagCategoryService(opts ...option.RequestOption) (r *ThreatEventTagCategoryService)
NewThreatEventTagCategoryService 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 (*ThreatEventTagCategoryService) Delete ¶ added in v7.8.0
func (r *ThreatEventTagCategoryService) Delete(ctx context.Context, categoryUUID string, body ThreatEventTagCategoryDeleteParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryDeleteResponse, err error)
Deletes a Source-of-Truth tag category by UUID.
func (*ThreatEventTagCategoryService) Edit ¶ added in v7.8.0
func (r *ThreatEventTagCategoryService) Edit(ctx context.Context, categoryUUID string, params ThreatEventTagCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryEditResponse, err error)
Updates a Source-of-Truth tag category by UUID.
func (*ThreatEventTagCategoryService) List ¶ added in v7.8.0
func (r *ThreatEventTagCategoryService) List(ctx context.Context, params ThreatEventTagCategoryListParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryListResponse, err error)
Returns all Source-of-Truth tag categories for an account.
func (*ThreatEventTagCategoryService) New ¶ added in v7.8.0
func (r *ThreatEventTagCategoryService) New(ctx context.Context, params ThreatEventTagCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryNewResponse, err error)
Creates a new Source-of-Truth tag category for an account.
type ThreatEventTagDeleteParams ¶ added in v7.8.0
type ThreatEventTagDeleteResponse ¶ added in v7.8.0
type ThreatEventTagDeleteResponse struct {
UUID string `json:"uuid" api:"required"`
JSON threatEventTagDeleteResponseJSON `json:"-"`
}
func (*ThreatEventTagDeleteResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagEditParams ¶ added in v7.8.0
type ThreatEventTagEditParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
ActiveDuration param.Field[string] `json:"activeDuration"`
// Actor variety. Allowed values: Activist, Competitor, Customer, Crime Syndicate,
// Former Employee, Nation State, Organized Crime, Nation State Affiliated,
// Terrorist, Unaffiliated.
ActorCategory param.Field[string] `json:"actorCategory"`
// Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped
// from responses to non-CFONE accounts.
ActorCategoryConfidence param.Field[int64] `json:"actorCategoryConfidence"`
// Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
// responses to non-CFONE accounts.
Aliases param.Field[[]ThreatEventTagEditParamsAlias] `json:"aliases"`
AliasGroupNames param.Field[[]string] `json:"aliasGroupNames"`
AliasGroupNamesInternal param.Field[[]string] `json:"aliasGroupNamesInternal"`
AnalyticPriority param.Field[float64] `json:"analyticPriority"`
AttributionConfidence param.Field[string] `json:"attributionConfidence"`
AttributionConfidenceScore param.Field[int64] `json:"attributionConfidenceScore"`
AttributionOrganization param.Field[string] `json:"attributionOrganization"`
CategoryUUID param.Field[string] `json:"categoryUuid"`
// Date the actor was discovered (ISO YYYY-MM-DD).
DateOfDiscovery param.Field[string] `json:"dateOfDiscovery"`
ExternalReferenceLinks param.Field[[]string] `json:"externalReferenceLinks"`
// Structured external references ({ url, description }). Public: returned to all
// accounts.
ExternalReferences param.Field[[]ThreatEventTagEditParamsExternalReference] `json:"externalReferences"`
// Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
// returned to non-CFONE accounts.
InternalAliases param.Field[[]ThreatEventTagEditParamsInternalAlias] `json:"internalAliases"`
InternalDescription param.Field[string] `json:"internalDescription"`
// Actor motive. Allowed values: Convenience, Fear, Fun, Financial, Grudge,
// Ideology, Espionage.
Motive param.Field[string] `json:"motive"`
// Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to
// non-CFONE accounts.
MotiveConfidence param.Field[int64] `json:"motiveConfidence"`
OpsecLevel param.Field[string] `json:"opsecLevel"`
// Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryConfidence param.Field[int64] `json:"originCountryConfidence"`
OriginCountryISO param.Field[string] `json:"originCountryISO"`
// TLP marking for the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryTLP param.Field[ThreatEventTagEditParamsOriginCountryTLP] `json:"originCountryTlp"`
Priority param.Field[float64] `json:"priority"`
SophisticationLevel param.Field[string] `json:"sophisticationLevel"`
Value param.Field[string] `json:"value"`
}
func (ThreatEventTagEditParams) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagEditParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagEditParamsAlias ¶ added in v7.8.0
type ThreatEventTagEditParamsAlias struct {
Value param.Field[string] `json:"value" api:"required"`
Confidence param.Field[int64] `json:"confidence"`
TLP param.Field[ThreatEventTagEditParamsAliasesTLP] `json:"tlp"`
}
func (ThreatEventTagEditParamsAlias) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagEditParamsAlias) MarshalJSON() (data []byte, err error)
type ThreatEventTagEditParamsAliasesTLP ¶ added in v7.8.0
type ThreatEventTagEditParamsAliasesTLP string
const ( ThreatEventTagEditParamsAliasesTLPRed ThreatEventTagEditParamsAliasesTLP = "red" ThreatEventTagEditParamsAliasesTLPAmber ThreatEventTagEditParamsAliasesTLP = "amber" ThreatEventTagEditParamsAliasesTLPGreen ThreatEventTagEditParamsAliasesTLP = "green" ThreatEventTagEditParamsAliasesTLPWhite ThreatEventTagEditParamsAliasesTLP = "white" )
func (ThreatEventTagEditParamsAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditParamsAliasesTLP) IsKnown() bool
type ThreatEventTagEditParamsExternalReference ¶ added in v7.8.0
type ThreatEventTagEditParamsExternalReference struct {
URL param.Field[string] `json:"url" api:"required"`
Description param.Field[string] `json:"description"`
}
func (ThreatEventTagEditParamsExternalReference) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagEditParamsExternalReference) MarshalJSON() (data []byte, err error)
type ThreatEventTagEditParamsInternalAlias ¶ added in v7.8.0
type ThreatEventTagEditParamsInternalAlias struct {
Value param.Field[string] `json:"value" api:"required"`
Confidence param.Field[int64] `json:"confidence"`
TLP param.Field[ThreatEventTagEditParamsInternalAliasesTLP] `json:"tlp"`
}
func (ThreatEventTagEditParamsInternalAlias) MarshalJSON ¶ added in v7.8.0
func (r ThreatEventTagEditParamsInternalAlias) MarshalJSON() (data []byte, err error)
type ThreatEventTagEditParamsInternalAliasesTLP ¶ added in v7.8.0
type ThreatEventTagEditParamsInternalAliasesTLP string
const ( ThreatEventTagEditParamsInternalAliasesTLPRed ThreatEventTagEditParamsInternalAliasesTLP = "red" ThreatEventTagEditParamsInternalAliasesTLPAmber ThreatEventTagEditParamsInternalAliasesTLP = "amber" ThreatEventTagEditParamsInternalAliasesTLPGreen ThreatEventTagEditParamsInternalAliasesTLP = "green" ThreatEventTagEditParamsInternalAliasesTLPWhite ThreatEventTagEditParamsInternalAliasesTLP = "white" )
func (ThreatEventTagEditParamsInternalAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditParamsInternalAliasesTLP) IsKnown() bool
type ThreatEventTagEditParamsOriginCountryTLP ¶ added in v7.8.0
type ThreatEventTagEditParamsOriginCountryTLP string
TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.
const ( ThreatEventTagEditParamsOriginCountryTLPRed ThreatEventTagEditParamsOriginCountryTLP = "red" ThreatEventTagEditParamsOriginCountryTLPAmber ThreatEventTagEditParamsOriginCountryTLP = "amber" ThreatEventTagEditParamsOriginCountryTLPGreen ThreatEventTagEditParamsOriginCountryTLP = "green" ThreatEventTagEditParamsOriginCountryTLPWhite ThreatEventTagEditParamsOriginCountryTLP = "white" )
func (ThreatEventTagEditParamsOriginCountryTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditParamsOriginCountryTLP) IsKnown() bool
type ThreatEventTagEditResponse ¶ added in v7.8.0
type ThreatEventTagEditResponse struct {
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
ActiveDuration string `json:"activeDuration"`
ActorCategory string `json:"actorCategory"`
// Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped
// from responses to non-CFONE accounts.
ActorCategoryConfidence int64 `json:"actorCategoryConfidence"`
// Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
// responses to non-CFONE accounts.
Aliases []ThreatEventTagEditResponseAlias `json:"aliases"`
AliasGroupNames []string `json:"aliasGroupNames"`
AliasGroupNamesInternal []string `json:"aliasGroupNamesInternal"`
AnalyticPriority float64 `json:"analyticPriority"`
AttributionConfidence string `json:"attributionConfidence"`
AttributionConfidenceScore int64 `json:"attributionConfidenceScore"`
AttributionOrganization string `json:"attributionOrganization"`
CategoryName string `json:"categoryName"`
CategoryUUID string `json:"categoryUuid"`
DateOfDiscovery string `json:"dateOfDiscovery"`
ExternalReferenceLinks []string `json:"externalReferenceLinks"`
// Structured external references ({ url, description }). Public: returned to all
// accounts.
ExternalReferences []ThreatEventTagEditResponseExternalReference `json:"externalReferences"`
// Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
// returned to non-CFONE accounts.
InternalAliases []ThreatEventTagEditResponseInternalAlias `json:"internalAliases"`
InternalDescription string `json:"internalDescription"`
Motive string `json:"motive"`
// Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to
// non-CFONE accounts.
MotiveConfidence int64 `json:"motiveConfidence"`
OpsecLevel string `json:"opsecLevel"`
// Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryConfidence int64 `json:"originCountryConfidence"`
OriginCountryISO string `json:"originCountryISO"`
OriginCountryISOAlpha3 string `json:"originCountryISOAlpha3"`
// TLP marking for the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryTLP ThreatEventTagEditResponseOriginCountryTLP `json:"originCountryTlp"`
Priority float64 `json:"priority"`
SophisticationLevel string `json:"sophisticationLevel"`
JSON threatEventTagEditResponseJSON `json:"-"`
}
func (*ThreatEventTagEditResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagEditResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagEditResponseAlias ¶ added in v7.8.0
type ThreatEventTagEditResponseAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagEditResponseAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagEditResponseAliasJSON `json:"-"`
}
func (*ThreatEventTagEditResponseAlias) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagEditResponseAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagEditResponseAliasesTLP ¶ added in v7.8.0
type ThreatEventTagEditResponseAliasesTLP string
const ( ThreatEventTagEditResponseAliasesTLPRed ThreatEventTagEditResponseAliasesTLP = "red" ThreatEventTagEditResponseAliasesTLPAmber ThreatEventTagEditResponseAliasesTLP = "amber" ThreatEventTagEditResponseAliasesTLPGreen ThreatEventTagEditResponseAliasesTLP = "green" ThreatEventTagEditResponseAliasesTLPWhite ThreatEventTagEditResponseAliasesTLP = "white" )
func (ThreatEventTagEditResponseAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditResponseAliasesTLP) IsKnown() bool
type ThreatEventTagEditResponseExternalReference ¶ added in v7.8.0
type ThreatEventTagEditResponseExternalReference struct {
URL string `json:"url" api:"required"`
Description string `json:"description" api:"nullable"`
JSON threatEventTagEditResponseExternalReferenceJSON `json:"-"`
}
func (*ThreatEventTagEditResponseExternalReference) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagEditResponseExternalReference) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagEditResponseInternalAlias ¶ added in v7.8.0
type ThreatEventTagEditResponseInternalAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagEditResponseInternalAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagEditResponseInternalAliasJSON `json:"-"`
}
func (*ThreatEventTagEditResponseInternalAlias) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagEditResponseInternalAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagEditResponseInternalAliasesTLP ¶ added in v7.8.0
type ThreatEventTagEditResponseInternalAliasesTLP string
const ( ThreatEventTagEditResponseInternalAliasesTLPRed ThreatEventTagEditResponseInternalAliasesTLP = "red" ThreatEventTagEditResponseInternalAliasesTLPAmber ThreatEventTagEditResponseInternalAliasesTLP = "amber" ThreatEventTagEditResponseInternalAliasesTLPGreen ThreatEventTagEditResponseInternalAliasesTLP = "green" ThreatEventTagEditResponseInternalAliasesTLPWhite ThreatEventTagEditResponseInternalAliasesTLP = "white" )
func (ThreatEventTagEditResponseInternalAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditResponseInternalAliasesTLP) IsKnown() bool
type ThreatEventTagEditResponseOriginCountryTLP ¶ added in v7.8.0
type ThreatEventTagEditResponseOriginCountryTLP string
TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.
const ( ThreatEventTagEditResponseOriginCountryTLPRed ThreatEventTagEditResponseOriginCountryTLP = "red" ThreatEventTagEditResponseOriginCountryTLPAmber ThreatEventTagEditResponseOriginCountryTLP = "amber" ThreatEventTagEditResponseOriginCountryTLPGreen ThreatEventTagEditResponseOriginCountryTLP = "green" ThreatEventTagEditResponseOriginCountryTLPWhite ThreatEventTagEditResponseOriginCountryTLP = "white" )
func (ThreatEventTagEditResponseOriginCountryTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagEditResponseOriginCountryTLP) IsKnown() bool
type ThreatEventTagIndicatorByDatasetListParams ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
IndicatorType param.Field[string] `query:"indicatorType"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
// repeating the parameter.
RelatedEvent param.Field[[]string] `query:"relatedEvent"`
// Structured search as a JSON array of {field, op, value} objects. Searchable
// fields: value, indicatorType. Multiple conditions are AND'd together. Max 10
// conditions per request.
Search param.Field[[]ThreatEventTagIndicatorByDatasetListParamsSearch] `query:"search"`
}
func (ThreatEventTagIndicatorByDatasetListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagIndicatorByDatasetListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagIndicatorByDatasetListParams's query parameters as `url.Values`.
type ThreatEventTagIndicatorByDatasetListParamsSearch ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParamsSearch struct {
// The indicator field to search on. Allowed: value, indicatorType, uuid.
Field param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchField] `query:"field" api:"required"`
// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
// {field:'value', op:'in', value:['evil.com','bad.org']}.
Op param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchOp] `query:"op" api:"required"`
// Search value. String for most operators. Array of strings for 'in' operator (max
// 100 items).
Value param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion] `query:"value" api:"required"`
}
func (ThreatEventTagIndicatorByDatasetListParamsSearch) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagIndicatorByDatasetListParamsSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagIndicatorByDatasetListParamsSearch's query parameters as `url.Values`.
type ThreatEventTagIndicatorByDatasetListParamsSearchField ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParamsSearchField string
The indicator field to search on. Allowed: value, indicatorType, uuid.
const ( ThreatEventTagIndicatorByDatasetListParamsSearchFieldValue ThreatEventTagIndicatorByDatasetListParamsSearchField = "value" ThreatEventTagIndicatorByDatasetListParamsSearchFieldIndicatorType ThreatEventTagIndicatorByDatasetListParamsSearchField = "indicatorType" ThreatEventTagIndicatorByDatasetListParamsSearchFieldUUID ThreatEventTagIndicatorByDatasetListParamsSearchField = "uuid" )
func (ThreatEventTagIndicatorByDatasetListParamsSearchField) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagIndicatorByDatasetListParamsSearchField) IsKnown() bool
type ThreatEventTagIndicatorByDatasetListParamsSearchOp ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParamsSearchOp string
Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}.
const ( ThreatEventTagIndicatorByDatasetListParamsSearchOpEquals ThreatEventTagIndicatorByDatasetListParamsSearchOp = "equals" ThreatEventTagIndicatorByDatasetListParamsSearchOpNot ThreatEventTagIndicatorByDatasetListParamsSearchOp = "not" ThreatEventTagIndicatorByDatasetListParamsSearchOpGt ThreatEventTagIndicatorByDatasetListParamsSearchOp = "gt" ThreatEventTagIndicatorByDatasetListParamsSearchOpGte ThreatEventTagIndicatorByDatasetListParamsSearchOp = "gte" ThreatEventTagIndicatorByDatasetListParamsSearchOpLt ThreatEventTagIndicatorByDatasetListParamsSearchOp = "lt" ThreatEventTagIndicatorByDatasetListParamsSearchOpLte ThreatEventTagIndicatorByDatasetListParamsSearchOp = "lte" ThreatEventTagIndicatorByDatasetListParamsSearchOpLike ThreatEventTagIndicatorByDatasetListParamsSearchOp = "like" ThreatEventTagIndicatorByDatasetListParamsSearchOpContains ThreatEventTagIndicatorByDatasetListParamsSearchOp = "contains" ThreatEventTagIndicatorByDatasetListParamsSearchOpStartsWith ThreatEventTagIndicatorByDatasetListParamsSearchOp = "startsWith" ThreatEventTagIndicatorByDatasetListParamsSearchOpEndsWith ThreatEventTagIndicatorByDatasetListParamsSearchOp = "endsWith" ThreatEventTagIndicatorByDatasetListParamsSearchOpIn ThreatEventTagIndicatorByDatasetListParamsSearchOp = "in" ThreatEventTagIndicatorByDatasetListParamsSearchOpFind ThreatEventTagIndicatorByDatasetListParamsSearchOp = "find" )
func (ThreatEventTagIndicatorByDatasetListParamsSearchOp) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagIndicatorByDatasetListParamsSearchOp) IsKnown() bool
type ThreatEventTagIndicatorByDatasetListParamsSearchValueArray ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParamsSearchValueArray []string
func (ThreatEventTagIndicatorByDatasetListParamsSearchValueArray) ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion ¶ added in v7.8.0
func (r ThreatEventTagIndicatorByDatasetListParamsSearchValueArray) ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion()
type ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion interface {
ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion()
}
Search value. String for most operators. Array of strings for 'in' operator (max 100 items).
Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagIndicatorByDatasetListParamsSearchValueArray.
type ThreatEventTagIndicatorByDatasetListResponse ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListResponse struct {
Indicators []ThreatEventTagIndicatorByDatasetListResponseIndicator `json:"indicators" api:"required"`
Pagination ThreatEventTagIndicatorByDatasetListResponsePagination `json:"pagination" api:"required"`
JSON threatEventTagIndicatorByDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventTagIndicatorByDatasetListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorByDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorByDatasetListResponseIndicator ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListResponseIndicator struct {
CreatedAt time.Time `json:"createdAt" api:"required" format:"date-time"`
IndicatorType string `json:"indicatorType" api:"required"`
UpdatedAt time.Time `json:"updatedAt" api:"required" format:"date-time"`
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
// The dataset ID this indicator belongs to. Included in list responses.
DatasetID string `json:"datasetId"`
RelatedEvents []ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
Tags []ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag `json:"tags"`
JSON threatEventTagIndicatorByDatasetListResponseIndicatorJSON `json:"-"`
}
func (*ThreatEventTagIndicatorByDatasetListResponseIndicator) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorByDatasetListResponseIndicator) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent struct {
DatasetID string `json:"datasetId" api:"required"`
EventID string `json:"eventId" api:"required"`
// ISO 8601 date of the related event. Null for legacy relationships created before
// event-date tracking was added.
EventDate string `json:"eventDate" api:"nullable"`
JSON threatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEventJSON `json:"-"`
}
func (*ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag struct {
CategoryName string `json:"categoryName"`
UUID string `json:"uuid"`
Value string `json:"value"`
JSON threatEventTagIndicatorByDatasetListResponseIndicatorsTagJSON `json:"-"`
}
func (*ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorByDatasetListResponsePagination ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetListResponsePagination struct {
Page float64 `json:"page" api:"required"`
PageSize float64 `json:"pageSize" api:"required"`
TotalCount float64 `json:"totalCount" api:"required"`
TotalPages float64 `json:"totalPages" api:"required"`
JSON threatEventTagIndicatorByDatasetListResponsePaginationJSON `json:"-"`
}
func (*ThreatEventTagIndicatorByDatasetListResponsePagination) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorByDatasetListResponsePagination) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorByDatasetService ¶ added in v7.8.0
type ThreatEventTagIndicatorByDatasetService struct {
Options []option.RequestOption
}
ThreatEventTagIndicatorByDatasetService 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 NewThreatEventTagIndicatorByDatasetService method instead.
func NewThreatEventTagIndicatorByDatasetService ¶ added in v7.8.0
func NewThreatEventTagIndicatorByDatasetService(opts ...option.RequestOption) (r *ThreatEventTagIndicatorByDatasetService)
NewThreatEventTagIndicatorByDatasetService 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 (*ThreatEventTagIndicatorByDatasetService) List
deprecated
added in
v7.8.0
func (r *ThreatEventTagIndicatorByDatasetService) List(ctx context.Context, datasetID string, tagUUID string, params ThreatEventTagIndicatorByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventTagIndicatorByDatasetListResponse, err error)
This endpoint is deprecated. Use GET /:account_id/events/tags/:tag_uuid/indicators with the optional datasetIds query parameter instead. Returns indicators associated with the provided tag UUID within a single dataset's indicator shards, with pagination.
Deprecated: Use list instead (GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/indicators).
type ThreatEventTagIndicatorListParams ¶ added in v7.8.0
type ThreatEventTagIndicatorListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Dataset UUIDs to scope to (repeat the param for multiple), or 'all' / '\*' for
// every readable indicator dataset. Omit to search all readable datasets.
DatasetIDs param.Field[[]string] `query:"datasetIds"`
IndicatorType param.Field[string] `query:"indicatorType"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
// repeating the parameter.
RelatedEvent param.Field[[]string] `query:"relatedEvent"`
// Structured search as a JSON array of {field, op, value} objects. Searchable
// fields: value, indicatorType. Multiple conditions are AND'd together. Max 10
// conditions per request.
Search param.Field[[]ThreatEventTagIndicatorListParamsSearch] `query:"search"`
}
func (ThreatEventTagIndicatorListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagIndicatorListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagIndicatorListParams's query parameters as `url.Values`.
type ThreatEventTagIndicatorListParamsSearch ¶ added in v7.8.0
type ThreatEventTagIndicatorListParamsSearch struct {
// The indicator field to search on. Allowed: value, indicatorType, uuid.
Field param.Field[ThreatEventTagIndicatorListParamsSearchField] `query:"field" api:"required"`
// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
// {field:'value', op:'in', value:['evil.com','bad.org']}.
Op param.Field[ThreatEventTagIndicatorListParamsSearchOp] `query:"op" api:"required"`
// Search value. String for most operators. Array of strings for 'in' operator (max
// 100 items).
Value param.Field[ThreatEventTagIndicatorListParamsSearchValueUnion] `query:"value" api:"required"`
}
func (ThreatEventTagIndicatorListParamsSearch) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagIndicatorListParamsSearch) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagIndicatorListParamsSearch's query parameters as `url.Values`.
type ThreatEventTagIndicatorListParamsSearchField ¶ added in v7.8.0
type ThreatEventTagIndicatorListParamsSearchField string
The indicator field to search on. Allowed: value, indicatorType, uuid.
const ( ThreatEventTagIndicatorListParamsSearchFieldValue ThreatEventTagIndicatorListParamsSearchField = "value" ThreatEventTagIndicatorListParamsSearchFieldIndicatorType ThreatEventTagIndicatorListParamsSearchField = "indicatorType" ThreatEventTagIndicatorListParamsSearchFieldUUID ThreatEventTagIndicatorListParamsSearchField = "uuid" )
func (ThreatEventTagIndicatorListParamsSearchField) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagIndicatorListParamsSearchField) IsKnown() bool
type ThreatEventTagIndicatorListParamsSearchOp ¶ added in v7.8.0
type ThreatEventTagIndicatorListParamsSearchOp string
Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}.
const ( ThreatEventTagIndicatorListParamsSearchOpEquals ThreatEventTagIndicatorListParamsSearchOp = "equals" ThreatEventTagIndicatorListParamsSearchOpNot ThreatEventTagIndicatorListParamsSearchOp = "not" ThreatEventTagIndicatorListParamsSearchOpGt ThreatEventTagIndicatorListParamsSearchOp = "gt" ThreatEventTagIndicatorListParamsSearchOpGte ThreatEventTagIndicatorListParamsSearchOp = "gte" ThreatEventTagIndicatorListParamsSearchOpLt ThreatEventTagIndicatorListParamsSearchOp = "lt" ThreatEventTagIndicatorListParamsSearchOpLte ThreatEventTagIndicatorListParamsSearchOp = "lte" ThreatEventTagIndicatorListParamsSearchOpLike ThreatEventTagIndicatorListParamsSearchOp = "like" ThreatEventTagIndicatorListParamsSearchOpContains ThreatEventTagIndicatorListParamsSearchOp = "contains" ThreatEventTagIndicatorListParamsSearchOpStartsWith ThreatEventTagIndicatorListParamsSearchOp = "startsWith" ThreatEventTagIndicatorListParamsSearchOpEndsWith ThreatEventTagIndicatorListParamsSearchOp = "endsWith" ThreatEventTagIndicatorListParamsSearchOpIn ThreatEventTagIndicatorListParamsSearchOp = "in" ThreatEventTagIndicatorListParamsSearchOpFind ThreatEventTagIndicatorListParamsSearchOp = "find" )
func (ThreatEventTagIndicatorListParamsSearchOp) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagIndicatorListParamsSearchOp) IsKnown() bool
type ThreatEventTagIndicatorListParamsSearchValueArray ¶ added in v7.8.0
type ThreatEventTagIndicatorListParamsSearchValueArray []string
func (ThreatEventTagIndicatorListParamsSearchValueArray) ImplementsThreatEventTagIndicatorListParamsSearchValueUnion ¶ added in v7.8.0
func (r ThreatEventTagIndicatorListParamsSearchValueArray) ImplementsThreatEventTagIndicatorListParamsSearchValueUnion()
type ThreatEventTagIndicatorListParamsSearchValueUnion ¶ added in v7.8.0
type ThreatEventTagIndicatorListParamsSearchValueUnion interface {
ImplementsThreatEventTagIndicatorListParamsSearchValueUnion()
}
Search value. String for most operators. Array of strings for 'in' operator (max 100 items).
Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagIndicatorListParamsSearchValueArray.
type ThreatEventTagIndicatorListResponse ¶ added in v7.8.0
type ThreatEventTagIndicatorListResponse struct {
Indicators []ThreatEventTagIndicatorListResponseIndicator `json:"indicators" api:"required"`
Pagination ThreatEventTagIndicatorListResponsePagination `json:"pagination" api:"required"`
JSON threatEventTagIndicatorListResponseJSON `json:"-"`
}
func (*ThreatEventTagIndicatorListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorListResponseIndicator ¶ added in v7.8.0
type ThreatEventTagIndicatorListResponseIndicator struct {
CreatedAt time.Time `json:"createdAt" api:"required" format:"date-time"`
IndicatorType string `json:"indicatorType" api:"required"`
UpdatedAt time.Time `json:"updatedAt" api:"required" format:"date-time"`
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
// The dataset ID this indicator belongs to. Included in list responses.
DatasetID string `json:"datasetId"`
RelatedEvents []ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
Tags []ThreatEventTagIndicatorListResponseIndicatorsTag `json:"tags"`
JSON threatEventTagIndicatorListResponseIndicatorJSON `json:"-"`
}
func (*ThreatEventTagIndicatorListResponseIndicator) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorListResponseIndicator) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent ¶ added in v7.8.0
type ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent struct {
DatasetID string `json:"datasetId" api:"required"`
EventID string `json:"eventId" api:"required"`
// ISO 8601 date of the related event. Null for legacy relationships created before
// event-date tracking was added.
EventDate string `json:"eventDate" api:"nullable"`
JSON threatEventTagIndicatorListResponseIndicatorsRelatedEventJSON `json:"-"`
}
func (*ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorListResponseIndicatorsTag ¶ added in v7.8.0
type ThreatEventTagIndicatorListResponseIndicatorsTag struct {
CategoryName string `json:"categoryName"`
UUID string `json:"uuid"`
Value string `json:"value"`
JSON threatEventTagIndicatorListResponseIndicatorsTagJSON `json:"-"`
}
func (*ThreatEventTagIndicatorListResponseIndicatorsTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorListResponseIndicatorsTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorListResponsePagination ¶ added in v7.8.0
type ThreatEventTagIndicatorListResponsePagination struct {
Page float64 `json:"page" api:"required"`
PageSize float64 `json:"pageSize" api:"required"`
TotalCount float64 `json:"totalCount" api:"required"`
TotalPages float64 `json:"totalPages" api:"required"`
JSON threatEventTagIndicatorListResponsePaginationJSON `json:"-"`
}
func (*ThreatEventTagIndicatorListResponsePagination) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorListResponsePagination) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagIndicatorService ¶ added in v7.8.0
type ThreatEventTagIndicatorService struct {
Options []option.RequestOption
ByDataset *ThreatEventTagIndicatorByDatasetService
}
ThreatEventTagIndicatorService 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 NewThreatEventTagIndicatorService method instead.
func NewThreatEventTagIndicatorService ¶ added in v7.8.0
func NewThreatEventTagIndicatorService(opts ...option.RequestOption) (r *ThreatEventTagIndicatorService)
NewThreatEventTagIndicatorService 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 (*ThreatEventTagIndicatorService) List ¶ added in v7.8.0
func (r *ThreatEventTagIndicatorService) List(ctx context.Context, tagUUID string, params ThreatEventTagIndicatorListParams, opts ...option.RequestOption) (res *ThreatEventTagIndicatorListResponse, err error)
Returns indicators associated with the provided tag UUID, with pagination. By default fans out across every indicator dataset the account can read; pass datasetIds to scope to specific datasets.
type ThreatEventTagListParams ¶ added in v7.8.0
type ThreatEventTagListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
Cache param.Field[ThreatEventTagListParamsCache] `query:"cache"`
CategoryUUID param.Field[string] `query:"categoryUuid"`
// Structured filters as a JSON array of {field, op, value} objects. Searchable
// fields: uuid, value, actorCategory, actorCategoryConfidence, aliasGroupNames,
// attributionConfidence, attributionConfidenceScore, attributionOrganization,
// categoryName, motive, motiveConfidence, opsecLevel, originCountryISO,
// originCountryConfidence, sophisticationLevel, priority, analyticPriority.
// Operators: equals, not, contains, startsWith, endsWith, gt, lt, gte, lte, like,
// in, find. Use 'in' for bulk OR within a single field, e.g.
// filters=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Multiple
// entries are AND-joined. Max 10 entries per request, max 100 values per 'in'.
// Per-field notes: `uuid` accepts only 'equals' and 'in' (other operators throw
// ValidationError) — matched against the canonical lowercase storage but callers
// may pass either case (the server lowercases before comparison); index-backed by
// the column's UNIQUE constraint and intended for batched UUID → tag resolution.
// `originCountryISO` uses its B-tree index for equals/not/in. `priority` uses its
// B-tree index for numeric comparisons. Other string columns (`actorCategory`,
// `motive`, etc.) are case-insensitive and unindexed; current catalog size makes
// this a non-issue. `endsWith` and `aliasGroupNames` contains/like are
// leading-wildcard scans and slow on large result sets. `aliasGroupNames` matches
// on the JSON-encoded text, so substrings can cross alias boundaries (a search for
// "apt28" will also match "apt280" if both appear in the same tag's alias list).
Filters param.Field[[]ThreatEventTagListParamsFilter] `query:"filters"`
Page param.Field[float64] `query:"page"`
PageSize param.Field[float64] `query:"pageSize"`
// Legacy free-text substring match on tag value.
Search param.Field[string] `query:"search"`
}
func (ThreatEventTagListParams) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagListParams) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagListParams's query parameters as `url.Values`.
type ThreatEventTagListParamsCache ¶ added in v7.8.0
type ThreatEventTagListParamsCache string
Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit.
const (
ThreatEventTagListParamsCacheFromGraph ThreatEventTagListParamsCache = "from-graph"
)
func (ThreatEventTagListParamsCache) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListParamsCache) IsKnown() bool
type ThreatEventTagListParamsFilter ¶ added in v7.8.0
type ThreatEventTagListParamsFilter struct {
// Tag field to search on. Allowed: uuid, value, actorCategory,
// actorCategoryConfidence, aliasGroupNames, attributionConfidence,
// attributionConfidenceScore, attributionOrganization, categoryName, motive,
// motiveConfidence, opsecLevel, originCountryISO, originCountryConfidence,
// sophisticationLevel, priority, analyticPriority.
Field param.Field[ThreatEventTagListParamsFiltersField] `query:"field" api:"required"`
// Search operator. Use 'in' for bulk OR within a single field, e.g.
// {field:"originCountryISO", op:"in", value:["IR","CN"]}.
Op param.Field[ThreatEventTagListParamsFiltersOp] `query:"op" api:"required"`
// Search value. String or number for most operators. Array for 'in' (max 100
// items). Country values may be passed as alpha-2, alpha-3, name, or common alias
// (e.g. 'iran', 'IR', 'IRN') and are normalized to alpha-2 server-side.
Value param.Field[ThreatEventTagListParamsFiltersValueUnion] `query:"value"`
}
func (ThreatEventTagListParamsFilter) URLQuery ¶ added in v7.8.0
func (r ThreatEventTagListParamsFilter) URLQuery() (v url.Values)
URLQuery serializes ThreatEventTagListParamsFilter's query parameters as `url.Values`.
type ThreatEventTagListParamsFiltersField ¶ added in v7.8.0
type ThreatEventTagListParamsFiltersField string
Tag field to search on. Allowed: uuid, value, actorCategory, actorCategoryConfidence, aliasGroupNames, attributionConfidence, attributionConfidenceScore, attributionOrganization, categoryName, motive, motiveConfidence, opsecLevel, originCountryISO, originCountryConfidence, sophisticationLevel, priority, analyticPriority.
const ( ThreatEventTagListParamsFiltersFieldUUID ThreatEventTagListParamsFiltersField = "uuid" ThreatEventTagListParamsFiltersFieldValue ThreatEventTagListParamsFiltersField = "value" ThreatEventTagListParamsFiltersFieldActorCategory ThreatEventTagListParamsFiltersField = "actorCategory" ThreatEventTagListParamsFiltersFieldActorCategoryConfidence ThreatEventTagListParamsFiltersField = "actorCategoryConfidence" ThreatEventTagListParamsFiltersFieldAliasGroupNames ThreatEventTagListParamsFiltersField = "aliasGroupNames" ThreatEventTagListParamsFiltersFieldAttributionConfidence ThreatEventTagListParamsFiltersField = "attributionConfidence" ThreatEventTagListParamsFiltersFieldAttributionConfidenceScore ThreatEventTagListParamsFiltersField = "attributionConfidenceScore" ThreatEventTagListParamsFiltersFieldAttributionOrganization ThreatEventTagListParamsFiltersField = "attributionOrganization" ThreatEventTagListParamsFiltersFieldCategoryName ThreatEventTagListParamsFiltersField = "categoryName" ThreatEventTagListParamsFiltersFieldMotive ThreatEventTagListParamsFiltersField = "motive" ThreatEventTagListParamsFiltersFieldMotiveConfidence ThreatEventTagListParamsFiltersField = "motiveConfidence" ThreatEventTagListParamsFiltersFieldOpsecLevel ThreatEventTagListParamsFiltersField = "opsecLevel" ThreatEventTagListParamsFiltersFieldOriginCountryISO ThreatEventTagListParamsFiltersField = "originCountryISO" ThreatEventTagListParamsFiltersFieldOriginCountryConfidence ThreatEventTagListParamsFiltersField = "originCountryConfidence" ThreatEventTagListParamsFiltersFieldSophisticationLevel ThreatEventTagListParamsFiltersField = "sophisticationLevel" ThreatEventTagListParamsFiltersFieldPriority ThreatEventTagListParamsFiltersField = "priority" ThreatEventTagListParamsFiltersFieldAnalyticPriority ThreatEventTagListParamsFiltersField = "analyticPriority" )
func (ThreatEventTagListParamsFiltersField) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListParamsFiltersField) IsKnown() bool
type ThreatEventTagListParamsFiltersOp ¶ added in v7.8.0
type ThreatEventTagListParamsFiltersOp string
Search operator. Use 'in' for bulk OR within a single field, e.g. {field:"originCountryISO", op:"in", value:["IR","CN"]}.
const ( ThreatEventTagListParamsFiltersOpEquals ThreatEventTagListParamsFiltersOp = "equals" ThreatEventTagListParamsFiltersOpNot ThreatEventTagListParamsFiltersOp = "not" ThreatEventTagListParamsFiltersOpGt ThreatEventTagListParamsFiltersOp = "gt" ThreatEventTagListParamsFiltersOpGte ThreatEventTagListParamsFiltersOp = "gte" ThreatEventTagListParamsFiltersOpLt ThreatEventTagListParamsFiltersOp = "lt" ThreatEventTagListParamsFiltersOpLte ThreatEventTagListParamsFiltersOp = "lte" ThreatEventTagListParamsFiltersOpLike ThreatEventTagListParamsFiltersOp = "like" ThreatEventTagListParamsFiltersOpContains ThreatEventTagListParamsFiltersOp = "contains" ThreatEventTagListParamsFiltersOpStartsWith ThreatEventTagListParamsFiltersOp = "startsWith" ThreatEventTagListParamsFiltersOpEndsWith ThreatEventTagListParamsFiltersOp = "endsWith" ThreatEventTagListParamsFiltersOpIn ThreatEventTagListParamsFiltersOp = "in" ThreatEventTagListParamsFiltersOpFind ThreatEventTagListParamsFiltersOp = "find" )
func (ThreatEventTagListParamsFiltersOp) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListParamsFiltersOp) IsKnown() bool
type ThreatEventTagListParamsFiltersValueArray ¶ added in v7.8.0
type ThreatEventTagListParamsFiltersValueArray []ThreatEventTagListParamsFiltersValueArrayItemUnion
func (ThreatEventTagListParamsFiltersValueArray) ImplementsThreatEventTagListParamsFiltersValueUnion ¶ added in v7.8.0
func (r ThreatEventTagListParamsFiltersValueArray) ImplementsThreatEventTagListParamsFiltersValueUnion()
type ThreatEventTagListParamsFiltersValueArrayItemUnion ¶ added in v7.8.0
type ThreatEventTagListParamsFiltersValueArrayItemUnion interface {
ImplementsThreatEventTagListParamsFiltersValueArrayItemUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type ThreatEventTagListParamsFiltersValueUnion ¶ added in v7.8.0
type ThreatEventTagListParamsFiltersValueUnion interface {
ImplementsThreatEventTagListParamsFiltersValueUnion()
}
Search value. String or number for most operators. Array for 'in' (max 100 items). Country values may be passed as alpha-2, alpha-3, name, or common alias (e.g. 'iran', 'IR', 'IRN') and are normalized to alpha-2 server-side.
Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventTagListParamsFiltersValueArray.
type ThreatEventTagListResponse ¶ added in v7.8.0
type ThreatEventTagListResponse struct {
Pagination ThreatEventTagListResponsePagination `json:"pagination" api:"required"`
Tags []ThreatEventTagListResponseTag `json:"tags" api:"required"`
JSON threatEventTagListResponseJSON `json:"-"`
}
func (*ThreatEventTagListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponsePagination ¶ added in v7.8.0
type ThreatEventTagListResponsePagination struct {
Page float64 `json:"page" api:"required"`
PageSize float64 `json:"pageSize" api:"required"`
TotalCount float64 `json:"totalCount" api:"required"`
TotalPages float64 `json:"totalPages" api:"required"`
JSON threatEventTagListResponsePaginationJSON `json:"-"`
}
func (*ThreatEventTagListResponsePagination) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponsePagination) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponseTag ¶ added in v7.8.0
type ThreatEventTagListResponseTag struct {
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
ActiveDuration string `json:"activeDuration"`
ActorCategory string `json:"actorCategory"`
// Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped
// from responses to non-CFONE accounts.
ActorCategoryConfidence int64 `json:"actorCategoryConfidence"`
// Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
// responses to non-CFONE accounts.
Aliases []ThreatEventTagListResponseTagsAlias `json:"aliases"`
AliasGroupNames []string `json:"aliasGroupNames"`
AliasGroupNamesInternal []string `json:"aliasGroupNamesInternal"`
AnalyticPriority float64 `json:"analyticPriority"`
AttributionConfidence string `json:"attributionConfidence"`
AttributionConfidenceScore int64 `json:"attributionConfidenceScore"`
AttributionOrganization string `json:"attributionOrganization"`
CategoryName string `json:"categoryName"`
CategoryUUID string `json:"categoryUuid"`
DateOfDiscovery string `json:"dateOfDiscovery"`
ExternalReferenceLinks []string `json:"externalReferenceLinks"`
// Structured external references ({ url, description }). Public: returned to all
// accounts.
ExternalReferences []ThreatEventTagListResponseTagsExternalReference `json:"externalReferences"`
// Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
// returned to non-CFONE accounts.
InternalAliases []ThreatEventTagListResponseTagsInternalAlias `json:"internalAliases"`
InternalDescription string `json:"internalDescription"`
Motive string `json:"motive"`
// Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to
// non-CFONE accounts.
MotiveConfidence int64 `json:"motiveConfidence"`
OpsecLevel string `json:"opsecLevel"`
// Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryConfidence int64 `json:"originCountryConfidence"`
OriginCountryISO string `json:"originCountryISO"`
OriginCountryISOAlpha3 string `json:"originCountryISOAlpha3"`
// TLP marking for the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryTLP ThreatEventTagListResponseTagsOriginCountryTLP `json:"originCountryTlp"`
Priority float64 `json:"priority"`
SophisticationLevel string `json:"sophisticationLevel"`
JSON threatEventTagListResponseTagJSON `json:"-"`
}
func (*ThreatEventTagListResponseTag) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponseTag) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponseTagsAlias ¶ added in v7.8.0
type ThreatEventTagListResponseTagsAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagListResponseTagsAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagListResponseTagsAliasJSON `json:"-"`
}
func (*ThreatEventTagListResponseTagsAlias) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponseTagsAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponseTagsAliasesTLP ¶ added in v7.8.0
type ThreatEventTagListResponseTagsAliasesTLP string
const ( ThreatEventTagListResponseTagsAliasesTLPRed ThreatEventTagListResponseTagsAliasesTLP = "red" ThreatEventTagListResponseTagsAliasesTLPAmber ThreatEventTagListResponseTagsAliasesTLP = "amber" ThreatEventTagListResponseTagsAliasesTLPGreen ThreatEventTagListResponseTagsAliasesTLP = "green" ThreatEventTagListResponseTagsAliasesTLPWhite ThreatEventTagListResponseTagsAliasesTLP = "white" )
func (ThreatEventTagListResponseTagsAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListResponseTagsAliasesTLP) IsKnown() bool
type ThreatEventTagListResponseTagsExternalReference ¶ added in v7.8.0
type ThreatEventTagListResponseTagsExternalReference struct {
URL string `json:"url" api:"required"`
Description string `json:"description" api:"nullable"`
JSON threatEventTagListResponseTagsExternalReferenceJSON `json:"-"`
}
func (*ThreatEventTagListResponseTagsExternalReference) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponseTagsExternalReference) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponseTagsInternalAlias ¶ added in v7.8.0
type ThreatEventTagListResponseTagsInternalAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagListResponseTagsInternalAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagListResponseTagsInternalAliasJSON `json:"-"`
}
func (*ThreatEventTagListResponseTagsInternalAlias) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTagListResponseTagsInternalAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagListResponseTagsInternalAliasesTLP ¶ added in v7.8.0
type ThreatEventTagListResponseTagsInternalAliasesTLP string
const ( ThreatEventTagListResponseTagsInternalAliasesTLPRed ThreatEventTagListResponseTagsInternalAliasesTLP = "red" ThreatEventTagListResponseTagsInternalAliasesTLPAmber ThreatEventTagListResponseTagsInternalAliasesTLP = "amber" ThreatEventTagListResponseTagsInternalAliasesTLPGreen ThreatEventTagListResponseTagsInternalAliasesTLP = "green" ThreatEventTagListResponseTagsInternalAliasesTLPWhite ThreatEventTagListResponseTagsInternalAliasesTLP = "white" )
func (ThreatEventTagListResponseTagsInternalAliasesTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListResponseTagsInternalAliasesTLP) IsKnown() bool
type ThreatEventTagListResponseTagsOriginCountryTLP ¶ added in v7.8.0
type ThreatEventTagListResponseTagsOriginCountryTLP string
TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.
const ( ThreatEventTagListResponseTagsOriginCountryTLPRed ThreatEventTagListResponseTagsOriginCountryTLP = "red" ThreatEventTagListResponseTagsOriginCountryTLPAmber ThreatEventTagListResponseTagsOriginCountryTLP = "amber" ThreatEventTagListResponseTagsOriginCountryTLPGreen ThreatEventTagListResponseTagsOriginCountryTLP = "green" ThreatEventTagListResponseTagsOriginCountryTLPWhite ThreatEventTagListResponseTagsOriginCountryTLP = "white" )
func (ThreatEventTagListResponseTagsOriginCountryTLP) IsKnown ¶ added in v7.8.0
func (r ThreatEventTagListResponseTagsOriginCountryTLP) IsKnown() bool
type ThreatEventTagNewParams ¶
type ThreatEventTagNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"required"`
Value param.Field[string] `json:"value" api:"required"`
ActiveDuration param.Field[string] `json:"activeDuration"`
// Actor variety. Allowed values: Activist, Competitor, Customer, Crime Syndicate,
// Former Employee, Nation State, Organized Crime, Nation State Affiliated,
// Terrorist, Unaffiliated.
ActorCategory param.Field[string] `json:"actorCategory"`
// Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped
// from responses to non-CFONE accounts.
ActorCategoryConfidence param.Field[int64] `json:"actorCategoryConfidence"`
// Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
// responses to non-CFONE accounts.
Aliases param.Field[[]ThreatEventTagNewParamsAlias] `json:"aliases"`
AliasGroupNames param.Field[[]string] `json:"aliasGroupNames"`
AliasGroupNamesInternal param.Field[[]string] `json:"aliasGroupNamesInternal"`
AnalyticPriority param.Field[float64] `json:"analyticPriority"`
AttributionConfidence param.Field[string] `json:"attributionConfidence"`
AttributionConfidenceScore param.Field[int64] `json:"attributionConfidenceScore"`
AttributionOrganization param.Field[string] `json:"attributionOrganization"`
CategoryUUID param.Field[string] `json:"categoryUuid"`
// Date the actor was discovered (ISO YYYY-MM-DD).
DateOfDiscovery param.Field[string] `json:"dateOfDiscovery"`
ExternalReferenceLinks param.Field[[]string] `json:"externalReferenceLinks"`
// Structured external references ({ url, description }). Public: returned to all
// accounts.
ExternalReferences param.Field[[]ThreatEventTagNewParamsExternalReference] `json:"externalReferences"`
// Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
// returned to non-CFONE accounts.
InternalAliases param.Field[[]ThreatEventTagNewParamsInternalAlias] `json:"internalAliases"`
InternalDescription param.Field[string] `json:"internalDescription"`
// Actor motive. Allowed values: Convenience, Fear, Fun, Financial, Grudge,
// Ideology, Espionage.
Motive param.Field[string] `json:"motive"`
// Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to
// non-CFONE accounts.
MotiveConfidence param.Field[int64] `json:"motiveConfidence"`
OpsecLevel param.Field[string] `json:"opsecLevel"`
// Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryConfidence param.Field[int64] `json:"originCountryConfidence"`
OriginCountryISO param.Field[string] `json:"originCountryISO"`
// TLP marking for the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryTLP param.Field[ThreatEventTagNewParamsOriginCountryTLP] `json:"originCountryTlp"`
Priority param.Field[float64] `json:"priority"`
SophisticationLevel param.Field[string] `json:"sophisticationLevel"`
}
func (ThreatEventTagNewParams) MarshalJSON ¶
func (r ThreatEventTagNewParams) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewParamsAlias ¶ added in v7.7.0
type ThreatEventTagNewParamsAlias struct {
Value param.Field[string] `json:"value" api:"required"`
Confidence param.Field[int64] `json:"confidence"`
TLP param.Field[ThreatEventTagNewParamsAliasesTLP] `json:"tlp"`
}
func (ThreatEventTagNewParamsAlias) MarshalJSON ¶ added in v7.7.0
func (r ThreatEventTagNewParamsAlias) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewParamsAliasesTLP ¶ added in v7.7.0
type ThreatEventTagNewParamsAliasesTLP string
const ( ThreatEventTagNewParamsAliasesTLPRed ThreatEventTagNewParamsAliasesTLP = "red" ThreatEventTagNewParamsAliasesTLPAmber ThreatEventTagNewParamsAliasesTLP = "amber" ThreatEventTagNewParamsAliasesTLPGreen ThreatEventTagNewParamsAliasesTLP = "green" ThreatEventTagNewParamsAliasesTLPWhite ThreatEventTagNewParamsAliasesTLP = "white" )
func (ThreatEventTagNewParamsAliasesTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewParamsAliasesTLP) IsKnown() bool
type ThreatEventTagNewParamsExternalReference ¶ added in v7.7.0
type ThreatEventTagNewParamsExternalReference struct {
URL param.Field[string] `json:"url" api:"required"`
Description param.Field[string] `json:"description"`
}
func (ThreatEventTagNewParamsExternalReference) MarshalJSON ¶ added in v7.7.0
func (r ThreatEventTagNewParamsExternalReference) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewParamsInternalAlias ¶ added in v7.7.0
type ThreatEventTagNewParamsInternalAlias struct {
Value param.Field[string] `json:"value" api:"required"`
Confidence param.Field[int64] `json:"confidence"`
TLP param.Field[ThreatEventTagNewParamsInternalAliasesTLP] `json:"tlp"`
}
func (ThreatEventTagNewParamsInternalAlias) MarshalJSON ¶ added in v7.7.0
func (r ThreatEventTagNewParamsInternalAlias) MarshalJSON() (data []byte, err error)
type ThreatEventTagNewParamsInternalAliasesTLP ¶ added in v7.7.0
type ThreatEventTagNewParamsInternalAliasesTLP string
const ( ThreatEventTagNewParamsInternalAliasesTLPRed ThreatEventTagNewParamsInternalAliasesTLP = "red" ThreatEventTagNewParamsInternalAliasesTLPAmber ThreatEventTagNewParamsInternalAliasesTLP = "amber" ThreatEventTagNewParamsInternalAliasesTLPGreen ThreatEventTagNewParamsInternalAliasesTLP = "green" ThreatEventTagNewParamsInternalAliasesTLPWhite ThreatEventTagNewParamsInternalAliasesTLP = "white" )
func (ThreatEventTagNewParamsInternalAliasesTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewParamsInternalAliasesTLP) IsKnown() bool
type ThreatEventTagNewParamsOriginCountryTLP ¶ added in v7.7.0
type ThreatEventTagNewParamsOriginCountryTLP string
TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.
const ( ThreatEventTagNewParamsOriginCountryTLPRed ThreatEventTagNewParamsOriginCountryTLP = "red" ThreatEventTagNewParamsOriginCountryTLPAmber ThreatEventTagNewParamsOriginCountryTLP = "amber" ThreatEventTagNewParamsOriginCountryTLPGreen ThreatEventTagNewParamsOriginCountryTLP = "green" ThreatEventTagNewParamsOriginCountryTLPWhite ThreatEventTagNewParamsOriginCountryTLP = "white" )
func (ThreatEventTagNewParamsOriginCountryTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewParamsOriginCountryTLP) IsKnown() bool
type ThreatEventTagNewResponse ¶
type ThreatEventTagNewResponse struct {
UUID string `json:"uuid" api:"required"`
Value string `json:"value" api:"required"`
ActiveDuration string `json:"activeDuration"`
ActorCategory string `json:"actorCategory"`
// Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped
// from responses to non-CFONE accounts.
ActorCategoryConfidence int64 `json:"actorCategoryConfidence"`
// Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from
// responses to non-CFONE accounts.
Aliases []ThreatEventTagNewResponseAlias `json:"aliases"`
AliasGroupNames []string `json:"aliasGroupNames"`
AliasGroupNamesInternal []string `json:"aliasGroupNamesInternal"`
AnalyticPriority float64 `json:"analyticPriority"`
AttributionConfidence string `json:"attributionConfidence"`
AttributionConfidenceScore int64 `json:"attributionConfidenceScore"`
AttributionOrganization string `json:"attributionOrganization"`
CategoryName string `json:"categoryName"`
CategoryUUID string `json:"categoryUuid"`
DateOfDiscovery string `json:"dateOfDiscovery"`
ExternalReferenceLinks []string `json:"externalReferenceLinks"`
// Structured external references ({ url, description }). Public: returned to all
// accounts.
ExternalReferences []ThreatEventTagNewResponseExternalReference `json:"externalReferences"`
// Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never
// returned to non-CFONE accounts.
InternalAliases []ThreatEventTagNewResponseInternalAlias `json:"internalAliases"`
InternalDescription string `json:"internalDescription"`
Motive string `json:"motive"`
// Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to
// non-CFONE accounts.
MotiveConfidence int64 `json:"motiveConfidence"`
OpsecLevel string `json:"opsecLevel"`
// Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryConfidence int64 `json:"originCountryConfidence"`
OriginCountryISO string `json:"originCountryISO"`
OriginCountryISOAlpha3 string `json:"originCountryISOAlpha3"`
// TLP marking for the origin-country attribution. CFONE-only: stripped from
// responses to non-CFONE accounts.
OriginCountryTLP ThreatEventTagNewResponseOriginCountryTLP `json:"originCountryTlp"`
Priority float64 `json:"priority"`
SophisticationLevel string `json:"sophisticationLevel"`
JSON threatEventTagNewResponseJSON `json:"-"`
}
func (*ThreatEventTagNewResponse) UnmarshalJSON ¶
func (r *ThreatEventTagNewResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagNewResponseAlias ¶ added in v7.7.0
type ThreatEventTagNewResponseAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagNewResponseAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagNewResponseAliasJSON `json:"-"`
}
func (*ThreatEventTagNewResponseAlias) UnmarshalJSON ¶ added in v7.7.0
func (r *ThreatEventTagNewResponseAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagNewResponseAliasesTLP ¶ added in v7.7.0
type ThreatEventTagNewResponseAliasesTLP string
const ( ThreatEventTagNewResponseAliasesTLPRed ThreatEventTagNewResponseAliasesTLP = "red" ThreatEventTagNewResponseAliasesTLPAmber ThreatEventTagNewResponseAliasesTLP = "amber" ThreatEventTagNewResponseAliasesTLPGreen ThreatEventTagNewResponseAliasesTLP = "green" ThreatEventTagNewResponseAliasesTLPWhite ThreatEventTagNewResponseAliasesTLP = "white" )
func (ThreatEventTagNewResponseAliasesTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewResponseAliasesTLP) IsKnown() bool
type ThreatEventTagNewResponseExternalReference ¶ added in v7.7.0
type ThreatEventTagNewResponseExternalReference struct {
URL string `json:"url" api:"required"`
Description string `json:"description" api:"nullable"`
JSON threatEventTagNewResponseExternalReferenceJSON `json:"-"`
}
func (*ThreatEventTagNewResponseExternalReference) UnmarshalJSON ¶ added in v7.7.0
func (r *ThreatEventTagNewResponseExternalReference) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagNewResponseInternalAlias ¶ added in v7.7.0
type ThreatEventTagNewResponseInternalAlias struct {
Value string `json:"value" api:"required"`
Confidence int64 `json:"confidence" api:"nullable"`
TLP ThreatEventTagNewResponseInternalAliasesTLP `json:"tlp" api:"nullable"`
JSON threatEventTagNewResponseInternalAliasJSON `json:"-"`
}
func (*ThreatEventTagNewResponseInternalAlias) UnmarshalJSON ¶ added in v7.7.0
func (r *ThreatEventTagNewResponseInternalAlias) UnmarshalJSON(data []byte) (err error)
type ThreatEventTagNewResponseInternalAliasesTLP ¶ added in v7.7.0
type ThreatEventTagNewResponseInternalAliasesTLP string
const ( ThreatEventTagNewResponseInternalAliasesTLPRed ThreatEventTagNewResponseInternalAliasesTLP = "red" ThreatEventTagNewResponseInternalAliasesTLPAmber ThreatEventTagNewResponseInternalAliasesTLP = "amber" ThreatEventTagNewResponseInternalAliasesTLPGreen ThreatEventTagNewResponseInternalAliasesTLP = "green" ThreatEventTagNewResponseInternalAliasesTLPWhite ThreatEventTagNewResponseInternalAliasesTLP = "white" )
func (ThreatEventTagNewResponseInternalAliasesTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewResponseInternalAliasesTLP) IsKnown() bool
type ThreatEventTagNewResponseOriginCountryTLP ¶ added in v7.7.0
type ThreatEventTagNewResponseOriginCountryTLP string
TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.
const ( ThreatEventTagNewResponseOriginCountryTLPRed ThreatEventTagNewResponseOriginCountryTLP = "red" ThreatEventTagNewResponseOriginCountryTLPAmber ThreatEventTagNewResponseOriginCountryTLP = "amber" ThreatEventTagNewResponseOriginCountryTLPGreen ThreatEventTagNewResponseOriginCountryTLP = "green" ThreatEventTagNewResponseOriginCountryTLPWhite ThreatEventTagNewResponseOriginCountryTLP = "white" )
func (ThreatEventTagNewResponseOriginCountryTLP) IsKnown ¶ added in v7.7.0
func (r ThreatEventTagNewResponseOriginCountryTLP) IsKnown() bool
type ThreatEventTagService ¶
type ThreatEventTagService struct {
Options []option.RequestOption
Categories *ThreatEventTagCategoryService
Indicators *ThreatEventTagIndicatorService
}
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) Delete ¶ added in v7.8.0
func (r *ThreatEventTagService) Delete(ctx context.Context, tagUUID string, body ThreatEventTagDeleteParams, opts ...option.RequestOption) (res *ThreatEventTagDeleteResponse, err error)
Deletes a Source-of-Truth tag by UUID.
func (*ThreatEventTagService) Edit ¶ added in v7.8.0
func (r *ThreatEventTagService) Edit(ctx context.Context, tagUUID string, params ThreatEventTagEditParams, opts ...option.RequestOption) (res *ThreatEventTagEditResponse, err error)
Updates a Source-of-Truth tag by UUID.
func (*ThreatEventTagService) List ¶ added in v7.8.0
func (r *ThreatEventTagService) List(ctx context.Context, params ThreatEventTagListParams, opts ...option.RequestOption) (res *ThreatEventTagListResponse, err error)
Returns all Source-of-Truth tags for an account. Supports legacy free-text `search` on tag value and `categoryUuid` exact match, plus a structured `filters` JSON array for filtering by metadata fields (originCountryISO, actorCategory, motive, priority, etc.). Country values may be passed as alpha-2, alpha-3, name, or common alias.
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 ThreatEventTargetIndustryByDatasetListParams ¶ added in v7.8.0
type ThreatEventTargetIndustryByDatasetListResponse ¶ added in v7.8.0
type ThreatEventTargetIndustryByDatasetListResponse struct {
Items ThreatEventTargetIndustryByDatasetListResponseItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryByDatasetListResponseJSON `json:"-"`
}
func (*ThreatEventTargetIndustryByDatasetListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryByDatasetListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryByDatasetListResponseItems ¶ added in v7.8.0
type ThreatEventTargetIndustryByDatasetListResponseItems struct {
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryByDatasetListResponseItemsJSON `json:"-"`
}
func (*ThreatEventTargetIndustryByDatasetListResponseItems) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryByDatasetListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryByDatasetService ¶ added in v7.8.0
type ThreatEventTargetIndustryByDatasetService struct {
Options []option.RequestOption
}
ThreatEventTargetIndustryByDatasetService 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 NewThreatEventTargetIndustryByDatasetService method instead.
func NewThreatEventTargetIndustryByDatasetService ¶ added in v7.8.0
func NewThreatEventTargetIndustryByDatasetService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryByDatasetService)
NewThreatEventTargetIndustryByDatasetService 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 (*ThreatEventTargetIndustryByDatasetService) List ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryByDatasetService) List(ctx context.Context, datasetID string, query ThreatEventTargetIndustryByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryByDatasetListResponse, err error)
Lists all target industries for a specific dataset
type ThreatEventTargetIndustryCatalogListParams ¶ added in v7.8.0
type ThreatEventTargetIndustryCatalogListResponse ¶ added in v7.8.0
type ThreatEventTargetIndustryCatalogListResponse struct {
Items ThreatEventTargetIndustryCatalogListResponseItems `json:"items" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryCatalogListResponseJSON `json:"-"`
}
func (*ThreatEventTargetIndustryCatalogListResponse) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryCatalogListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryCatalogListResponseItems ¶ added in v7.8.0
type ThreatEventTargetIndustryCatalogListResponseItems struct {
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryCatalogListResponseItemsJSON `json:"-"`
}
func (*ThreatEventTargetIndustryCatalogListResponseItems) UnmarshalJSON ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryCatalogListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryCatalogService ¶ added in v7.8.0
type ThreatEventTargetIndustryCatalogService struct {
Options []option.RequestOption
}
ThreatEventTargetIndustryCatalogService 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 NewThreatEventTargetIndustryCatalogService method instead.
func NewThreatEventTargetIndustryCatalogService ¶ added in v7.8.0
func NewThreatEventTargetIndustryCatalogService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryCatalogService)
NewThreatEventTargetIndustryCatalogService 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 (*ThreatEventTargetIndustryCatalogService) List ¶ added in v7.8.0
func (r *ThreatEventTargetIndustryCatalogService) List(ctx context.Context, query ThreatEventTargetIndustryCatalogListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryCatalogListResponse, err error)
Lists all target industries from industry map catalog
type ThreatEventTargetIndustryListParams ¶
type ThreatEventTargetIndustryListParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id" api:"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 ¶
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" api:"required"`
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryListResponseJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponse) UnmarshalJSON ¶
func (r *ThreatEventTargetIndustryListResponse) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryListResponseItems ¶
type ThreatEventTargetIndustryListResponseItems struct {
Type string `json:"type" api:"required"`
JSON threatEventTargetIndustryListResponseItemsJSON `json:"-"`
}
func (*ThreatEventTargetIndustryListResponseItems) UnmarshalJSON ¶
func (r *ThreatEventTargetIndustryListResponseItems) UnmarshalJSON(data []byte) (err error)
type ThreatEventTargetIndustryService ¶
type ThreatEventTargetIndustryService struct {
Options []option.RequestOption
ByDataset *ThreatEventTargetIndustryByDatasetService
Catalog *ThreatEventTargetIndustryCatalogService
}
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)
Retrieves the catalog of industry classifications used in Cloudforce One threat intelligence.
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
- threateventaggregate.go
- threateventattacker.go
- threateventcategory.go
- threateventcategorycatalog.go
- threateventcountry.go
- threateventcron.go
- threateventdataset.go
- threateventdatasetevent.go
- threateventdatasethealth.go
- threateventeventtag.go
- threateventgraph.go
- threateventgraphql.go
- threateventindicator.go
- threateventindicatoraggregate.go
- threateventindicatorbydataset.go
- threateventindicatorbydatasettag.go
- threateventindicatortype.go
- threateventinsight.go
- threateventquery.go
- threateventraw.go
- threateventrelate.go
- threateventrelationship.go
- threateventtag.go
- threateventtagcategory.go
- threateventtagindicator.go
- threateventtagindicatorbydataset.go
- threateventtargetindustry.go
- threateventtargetindustrybydataset.go
- threateventtargetindustrycatalog.go