--- title: Intel --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Intel #### IntelASN ##### [Get ASN Overview.](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/asn/methods/get) client.intel.asn.get([ASN]()asn, ASNGetParams {account\_id } params, RequestOptionsoptions?): [ASN]() GET/accounts/{account\_id}/intel/asn/{asn} #### IntelASNSubnets ##### [Get ASN Subnets](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/asn/subresources/subnets/methods/get) client.intel.asn.subnets.get([ASN]()asn, SubnetGetParams {account\_id } params, RequestOptionsoptions?): [SubnetGetResponse]() {asn, count, ip\_count\_total, 3 more } GET/accounts/{account\_id}/intel/asn/{asn}/subnets ##### ModelsExpand Collapse
SubnetGetResponse {asn, count, ip\_count\_total, 3 more } asn?: ASN Link to this property count?: number Total results returned based on your search parameters. Link to this property ip\_count\_total?: number Link to this property page?: number Current page within paginated list of results. Link to this property per\_page?: number Number of results per page of results. Link to this property subnets?: Array<string> Link to this property
[Link to this property](<#(resource)%20intel.asn.subnets%20%3E%20(model)%20subnet_get_response%20%3E%20(schema)>) #### IntelDNS ##### [Get Passive DNS by IP](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/dns/methods/list) client.intel.dns.list(DNSListParams {account\_id, ipv4, page, 2 more } params, RequestOptionsoptions?): V4PagePagination< [DNS]() {count, page, per\_page, reverse\_records } > GET/accounts/{account\_id}/intel/dns ##### ModelsExpand Collapse
DNS {count, page, per\_page, reverse\_records } count?: number Total results returned based on your search parameters. Link to this property page?: number Current page within paginated list of results. Link to this property per\_page?: number Number of results per page of results. Link to this property
reverse\_records?: Array<ReverseRecord> Reverse DNS look-ups observed during the time period. first\_seen?: string First seen date of the DNS record during the time period. formatdate Link to this property hostname?: string Hostname that the IP was observed resolving to. Link to this property last\_seen?: string Last seen date of the DNS record during the time period. formatdate Link to this property
Link to this property
[Link to this property](<#(resource)%20intel.dns%20%3E%20(model)%20dns%20%3E%20(schema)>) #### IntelDomains ##### [Get Domain Details](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/domains/methods/get) client.intel.domains.get(DomainGetParams {account\_id, domain, skip\_dns, skip\_ranking } params, RequestOptionsoptions?): [Domain]() {additional\_information, application, content\_categories, 8 more } GET/accounts/{account\_id}/intel/domain ##### ModelsExpand Collapse
Domain {additional\_information, application, content\_categories, 8 more }
additional\_information?: AdditionalInformation {suspected\_malware\_family } Additional information related to the host name. suspected\_malware\_family?: string Suspected DGA malware family. Link to this property
Link to this property
application?: Application {id, name } Application that the hostname belongs to. id?: number Link to this property name?: string Link to this property
Link to this property
content\_categories?: Array<ContentCategory> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property domain?: string Link to this property
inherited\_content\_categories?: Array<InheritedContentCategory> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property inherited\_from?: string Domain from which inherited_content_categories and inherited_risk_types are inherited, if applicable. Link to this property
inherited\_risk\_types?: Array<InheritedRiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property popularity\_rank?: number Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000. Link to this property
resolves\_to\_refs?: Array<ResolvesToRef> Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to. id?: string STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#\_64yvzeku5a5c. Link to this property value?: string IP address or domain name. Link to this property
Link to this property risk\_score?: number Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk). Link to this property
risk\_types?: Array<RiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property
[Link to this property](<#(resource)%20intel.domains%20%3E%20(model)%20domain%20%3E%20(schema)>) #### IntelDomainsBulks ##### [Get Multiple Domain Details](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/domains/subresources/bulks/methods/get) client.intel.domains.bulks.get(BulkGetParams {account\_id, domain, include\_ranking, skip\_ranking } params, RequestOptionsoptions?): [BulkGetResponse]()| null GET/accounts/{account\_id}/intel/domain/bulk ##### ModelsExpand Collapse
BulkGetResponse = Array<BulkGetResponseItem>| null
additional\_information?: AdditionalInformation {suspected\_malware\_family } Additional information related to the host name. suspected\_malware\_family?: string Suspected DGA malware family. Link to this property
Link to this property
application?: Application {id, name } Application that the hostname belongs to. id?: number Link to this property name?: string Link to this property
Link to this property
content\_categories?: Array<ContentCategory> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property domain?: string Link to this property
inherited\_content\_categories?: Array<InheritedContentCategory> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property inherited\_from?: string Domain from which inherited_content_categories and inherited_risk_types are inherited, if applicable. Link to this property
inherited\_risk\_types?: Array<InheritedRiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property popularity\_rank?: number Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000. Link to this property risk\_score?: number Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk). Link to this property
risk\_types?: Array<RiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property
[Link to this property](<#(resource)%20intel.domains.bulks%20%3E%20(model)%20bulk_get_response%20%3E%20(schema)>) #### IntelDomain History ##### [Get Domain History](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/domain_history/methods/get) client.intel.domainHistory.get(DomainHistoryGetParams {account\_id, domain } params, RequestOptionsoptions?): [DomainHistoryGetResponse]()| null GET/accounts/{account\_id}/intel/domain-history ##### ModelsExpand Collapse
DomainHistory {categorizations, domain }
categorizations?: Array<Categorization>
categories?: Array<Category> id?: number Link to this property name?: string Link to this property
Link to this property end?: string formatdate Link to this property start?: string formatdate Link to this property
Link to this property domain?: string Link to this property
[Link to this property](<#(resource)%20intel.domain_history%20%3E%20(model)%20domain_history%20%3E%20(schema)>)
DomainHistoryGetResponse = Array<DomainHistory {categorizations, domain } >| null
categorizations?: Array<Categorization>
categories?: Array<Category> id?: number Link to this property name?: string Link to this property
Link to this property end?: string formatdate Link to this property start?: string formatdate Link to this property
Link to this property domain?: string Link to this property
[Link to this property](<#(resource)%20intel.domain_history%20%3E%20(model)%20domain_history_get_response%20%3E%20(schema)>) #### IntelIPs ##### [Get IP Overview](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/ips/methods/get) client.intel.ips.get(IPGetParams {account\_id, ipv4, ipv6 } params, RequestOptionsoptions?): [IPGetResponse]()| null GET/accounts/{account\_id}/intel/ip ##### ModelsExpand Collapse
IP {belongs\_to\_ref, ip, risk\_types }
belongs\_to\_ref?: BelongsToRef {id, country, description, 2 more } Specifies a reference to the autonomous systems (AS) that the IP address belongs to. id?: string Link to this property country?: string Link to this property description?: string Link to this property
type?: "hosting\_provider"| "isp"| "organization" Infrastructure type of this ASN. One of the following: "hosting\_provider" Link to this property "isp" Link to this property "organization" Link to this property
Link to this property value?: string Link to this property
Link to this property ip?: string formatipv4 Link to this property
risk\_types?: Array<RiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property
[Link to this property](<#(resource)%20intel.ips%20%3E%20(model)%20ip%20%3E%20(schema)>)
IPGetResponse = Array<IP {belongs\_to\_ref, ip, risk\_types } >| null
belongs\_to\_ref?: BelongsToRef {id, country, description, 2 more } Specifies a reference to the autonomous systems (AS) that the IP address belongs to. id?: string Link to this property country?: string Link to this property description?: string Link to this property
type?: "hosting\_provider"| "isp"| "organization" Infrastructure type of this ASN. One of the following: "hosting\_provider" Link to this property "isp" Link to this property "organization" Link to this property
Link to this property value?: string Link to this property
Link to this property ip?: string formatipv4 Link to this property
risk\_types?: Array<RiskType> id?: number Link to this property name?: string Link to this property super\_category\_id?: number Link to this property
Link to this property
[Link to this property](<#(resource)%20intel.ips%20%3E%20(model)%20ip_get_response%20%3E%20(schema)>) #### IntelIP Lists ##### ModelsExpand Collapse
IPList {id, description, name } id?: number Link to this property description?: string Link to this property name?: string Link to this property
[Link to this property](<#(resource)%20intel.ip_lists%20%3E%20(model)%20ip_list%20%3E%20(schema)>) #### IntelMiscategorizations ##### [Create Miscategorization](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/miscategorizations/methods/create) client.intel.miscategorizations.create(MiscategorizationCreateParams {account\_id, content\_adds, content\_removes, 5 more } params, RequestOptionsoptions?): [MiscategorizationCreateResponse]() {errors, messages, success } POST/accounts/{account\_id}/intel/miscategorization ##### ModelsExpand Collapse
MiscategorizationCreateResponse {errors, messages, success }
errors: Array<Error> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property
messages: Array<Message> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property success: true Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20intel.miscategorizations%20%3E%20(model)%20miscategorization_create_response%20%3E%20(schema)>) #### IntelWhois ##### [Get WHOIS Record](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/whois/methods/get) client.intel.whois.get(WhoisGetParams {account\_id, domain } params, RequestOptionsoptions?): [WhoisGetResponse]() {dnssec, domain, extension, 84 more } GET/accounts/{account\_id}/intel/whois ##### ModelsExpand Collapse
Whois {created\_date, domain, nameservers, 6 more } created\_date?: string formatdate Link to this property domain?: string Link to this property nameservers?: Array<string> Link to this property registrant?: string Link to this property registrant\_country?: string Link to this property registrant\_email?: string Link to this property registrant\_org?: string Link to this property registrar?: string Link to this property updated\_date?: string formatdate Link to this property
[Link to this property](<#(resource)%20intel.whois%20%3E%20(model)%20whois%20%3E%20(schema)>)
WhoisGetResponse {dnssec, domain, extension, 84 more } dnssec: boolean Link to this property domain: string Link to this property extension: string Link to this property found: boolean Link to this property nameservers: Array<string> Link to this property punycode: string Link to this property registrant: string Link to this property registrar: string Link to this property id?: string Link to this property administrative\_city?: string Link to this property administrative\_country?: string Link to this property administrative\_email?: string Link to this property administrative\_fax?: string Link to this property administrative\_fax\_ext?: string Link to this property administrative\_id?: string Link to this property administrative\_name?: string Link to this property administrative\_org?: string Link to this property administrative\_phone?: string Link to this property administrative\_phone\_ext?: string Link to this property administrative\_postal\_code?: string Link to this property administrative\_province?: string Link to this property administrative\_referral\_url?: string Link to this property administrative\_street?: string Link to this property billing\_city?: string Link to this property billing\_country?: string Link to this property billing\_email?: string Link to this property billing\_fax?: string Link to this property billing\_fax\_ext?: string Link to this property billing\_id?: string Link to this property billing\_name?: string Link to this property billing\_org?: string Link to this property billing\_phone?: string Link to this property billing\_phone\_ext?: string Link to this property billing\_postal\_code?: string Link to this property billing\_province?: string Link to this property billing\_referral\_url?: string Link to this property billing\_street?: string Link to this property created\_date?: string formatdate-time Link to this property created\_date\_raw?: string Link to this property expiration\_date?: string formatdate-time Link to this property expiration\_date\_raw?: string Link to this property registrant\_city?: string Link to this property registrant\_country?: string Link to this property registrant\_email?: string Link to this property registrant\_fax?: string Link to this property registrant\_fax\_ext?: string Link to this property registrant\_id?: string Link to this property registrant\_name?: string Link to this property registrant\_org?: string Link to this property registrant\_phone?: string Link to this property registrant\_phone\_ext?: string Link to this property registrant\_postal\_code?: string Link to this property registrant\_province?: string Link to this property registrant\_referral\_url?: string Link to this property registrant\_street?: string Link to this property registrar\_city?: string Link to this property registrar\_country?: string Link to this property registrar\_email?: string Link to this property registrar\_fax?: string Link to this property registrar\_fax\_ext?: string Link to this property registrar\_id?: string Link to this property registrar\_name?: string Link to this property registrar\_org?: string Link to this property registrar\_phone?: string Link to this property registrar\_phone\_ext?: string Link to this property registrar\_postal\_code?: string Link to this property registrar\_province?: string Link to this property registrar\_referral\_url?: string Link to this property registrar\_street?: string Link to this property status?: Array<string> Link to this property technical\_city?: string Link to this property technical\_country?: string Link to this property technical\_email?: string Link to this property technical\_fax?: string Link to this property technical\_fax\_ext?: string Link to this property technical\_id?: string Link to this property technical\_name?: string Link to this property technical\_org?: string Link to this property technical\_phone?: string Link to this property technical\_phone\_ext?: string Link to this property technical\_postal\_code?: string Link to this property technical\_province?: string Link to this property technical\_referral\_url?: string Link to this property technical\_street?: string Link to this property updated\_date?: string formatdate-time Link to this property updated\_date\_raw?: string Link to this property whois\_server?: string Link to this property
[Link to this property](<#(resource)%20intel.whois%20%3E%20(model)%20whois_get_response%20%3E%20(schema)>) #### IntelURLs ##### [Get URL Intelligence](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/urls/methods/get) client.intel.urls.get(URLGetParams {account\_id, url } params, RequestOptionsoptions?): [URL]() {content\_categories, full\_url, hostname, 2 more } GET/accounts/{account\_id}/intel/url ##### ModelsExpand Collapse
URL {content\_categories, full\_url, hostname, 2 more }
content\_categories: Array<ContentCategory> Content categories associated with this URL. id?: number Link to this property name?: string Link to this property source\_id?: number Link to this property super\_category\_id?: number Link to this property
Link to this property full\_url: string The full URL that was looked up. Link to this property hostname: string The hostname of the URL. Link to this property
risk\_type: Array<RiskType> Security risk types associated with this URL. id?: number Link to this property name?: string Link to this property source\_id?: number Link to this property super\_category\_id?: number Link to this property
Link to this property url\_path: string The path component of the URL. Link to this property
[Link to this property](<#(resource)%20intel.urls%20%3E%20(model)%20url%20%3E%20(schema)>) #### IntelIndicator Feeds ##### [Get indicator feeds owned by this account](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/methods/list) client.intel.indicatorFeeds.list(IndicatorFeedListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [IndicatorFeedListResponse]() {id, created\_on, description, 5 more } > GET/accounts/{account\_id}/intel/indicator-feeds ##### [Get indicator feed metadata](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/methods/get) client.intel.indicatorFeeds.get(numberfeedID, IndicatorFeedGetParams {account\_id } params, RequestOptionsoptions?): [IndicatorFeedGetResponse]() {id, created\_on, description, 10 more } GET/accounts/{account\_id}/intel/indicator-feeds/{feed\_id} ##### [Create new indicator feed](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/methods/create) client.intel.indicatorFeeds.create(IndicatorFeedCreateParams {account\_id, description, name } params, RequestOptionsoptions?): [IndicatorFeedCreateResponse]() {id, created\_on, description, 5 more } POST/accounts/{account\_id}/intel/indicator-feeds ##### [Update indicator feed metadata](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/methods/update) client.intel.indicatorFeeds.update(numberfeedID, IndicatorFeedUpdateParams {account\_id, description, is\_attributable, 3 more } params, RequestOptionsoptions?): [IndicatorFeedUpdateResponse]() {id, created\_on, description, 5 more } PUT/accounts/{account\_id}/intel/indicator-feeds/{feed\_id} ##### [Get indicator feed data](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/methods/data) client.intel.indicatorFeeds.data(numberfeedID, IndicatorFeedDataParams {account\_id } params, RequestOptionsoptions?): [IndicatorFeedDataResponse]() GET/accounts/{account\_id}/intel/indicator-feeds/{feed\_id}/data ##### ModelsExpand Collapse
IndicatorFeedListResponse {id, created\_on, description, 5 more } id?: number The unique identifier for the indicator feed Link to this property created\_on?: string The date and time when the data entry was created formatdate-time Link to this property description?: string The description of the example test Link to this property is\_attributable?: boolean Whether the indicator feed can be attributed to a provider Link to this property is\_downloadable?: boolean Whether the indicator feed can be downloaded Link to this property is\_public?: boolean Whether the indicator feed is exposed to customers Link to this property modified\_on?: string The date and time when the data entry was last modified formatdate-time Link to this property name?: string The name of the indicator feed Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds%20%3E%20(model)%20indicator_feed_list_response%20%3E%20(schema)>)
IndicatorFeedGetResponse {id, created\_on, description, 10 more } id?: number The unique identifier for the indicator feed Link to this property created\_on?: string The date and time when the data entry was created formatdate-time Link to this property description?: string The description of the example test Link to this property is\_attributable?: boolean Whether the indicator feed can be attributed to a provider Link to this property is\_downloadable?: boolean Whether the indicator feed can be downloaded Link to this property is\_public?: boolean Whether the indicator feed is exposed to customers Link to this property
last\_upload\_summary?: LastUploadSummary {persisted, skipped, uploaded } Summary of indicator counts from the last successful upload to this feed. Populated by the custom-threat-feeds loader at the end of each successful load. Absent (omitted) when no upload has completed successfully or the upload errored before the summary write. Surfaces silent-failure paths so operators can see when their indicators were dropped (popularity allowlist, expired valid\_until, etc.) without reading loader logs.
persisted?: Persisted {domains\_added, domains\_removed, ips\_added, 3 more } Net delta applied to feed indicators by this upload. Snapshot uploads emit both \*\_added and \*\_removed; delta-add emits only \*\_added; delta-remove emits only \*\_removed. domains\_added?: number Link to this property domains\_removed?: number Link to this property ips\_added?: number Link to this property ips\_removed?: number Link to this property urls\_added?: number Link to this property urls\_removed?: number Link to this property
Link to this property
skipped?: Skipped {allowlisted\_domains, expired\_indicators, invalid\_indicators } Counts of indicators that were uploaded but did not reach QuickSilver, broken down by reason. allowlisted\_domains?: number Domains filtered by the global popularity allowlist at QS provisioning time. Popular domains (bing.com, naver.com, etc.) are protected from custom-threat-feed enforcement. Link to this property expired\_indicators?: number Indicators in the upload whose valid\_until is already in the past. These are not added to QS; the expiration cron handles cleanup. Link to this property invalid\_indicators?: number Reserved for future use. Currently always 0 — the unifier aborts the entire upload on a single bad indicator. Link to this property
Link to this property
uploaded?: Uploaded {domains, ips, urls } Indicator counts from the unified file the loader received domains?: number Number of domain indicators in the upload Link to this property ips?: number Number of IP indicators in the upload Link to this property urls?: number Number of URL indicators in the upload Link to this property
Link to this property
Link to this property latest\_upload\_error?: string Human-readable error message describing why the latest upload failed. Populated only when latest_upload_status is Error. Returns one of a small fixed set of category-level messages (invalid domain / IP / URL entries, malformed row or header, invalid valid\_until timestamp, etc.) or the generic Upload failed for unknown or infrastructure-level errors. Never echoes raw error text from the underlying loader. Intel accounts receive the verbatim loader/API error text (including specific offending values) instead of these category-level messages. Link to this property
latest\_upload\_status?: "Mirroring"| "Unifying"| "Loading"| 3 more Status of the latest snapshot uploaded One of the following: "Mirroring" Link to this property "Unifying" Link to this property "Loading" Link to this property "Provisioning" Link to this property "Complete" Link to this property "Error" Link to this property
Link to this property modified\_on?: string The date and time when the data entry was last modified formatdate-time Link to this property name?: string The name of the indicator feed Link to this property provider\_id?: number The unique identifier for the provider Link to this property provider\_name?: string The provider of the indicator feed Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds%20%3E%20(model)%20indicator_feed_get_response%20%3E%20(schema)>)
IndicatorFeedCreateResponse {id, created\_on, description, 5 more } id?: number The unique identifier for the indicator feed Link to this property created\_on?: string The date and time when the data entry was created formatdate-time Link to this property description?: string The description of the example test Link to this property is\_attributable?: boolean Whether the indicator feed can be attributed to a provider Link to this property is\_downloadable?: boolean Whether the indicator feed can be downloaded Link to this property is\_public?: boolean Whether the indicator feed is exposed to customers Link to this property modified\_on?: string The date and time when the data entry was last modified formatdate-time Link to this property name?: string The name of the indicator feed Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds%20%3E%20(model)%20indicator_feed_create_response%20%3E%20(schema)>)
IndicatorFeedUpdateResponse {id, created\_on, description, 5 more } id?: number The unique identifier for the indicator feed Link to this property created\_on?: string The date and time when the data entry was created formatdate-time Link to this property description?: string The description of the example test Link to this property is\_attributable?: boolean Whether the indicator feed can be attributed to a provider Link to this property is\_downloadable?: boolean Whether the indicator feed can be downloaded Link to this property is\_public?: boolean Whether the indicator feed is exposed to customers Link to this property modified\_on?: string The date and time when the data entry was last modified formatdate-time Link to this property name?: string The name of the indicator feed Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds%20%3E%20(model)%20indicator_feed_update_response%20%3E%20(schema)>) IndicatorFeedDataResponse = string [Link to this property](<#(resource)%20intel.indicator_feeds%20%3E%20(model)%20indicator_feed_data_response%20%3E%20(schema)>) #### IntelIndicator FeedsSnapshots ##### [Update indicator feed data](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/subresources/snapshots/methods/update) client.intel.indicatorFeeds.snapshots.update(numberfeedID, SnapshotUpdateParams {account\_id, source, cfAsyncUpload } params, RequestOptionsoptions?): [SnapshotUpdateResponse]() {file\_id, filename, poll\_url, 2 more } PUT/accounts/{account\_id}/intel/indicator-feeds/{feed\_id}/snapshot ##### ModelsExpand Collapse
SnapshotUpdateResponse {file\_id, filename, poll\_url, 2 more } file\_id?: number Feed id Link to this property filename?: string Name of the file unified in our system Link to this property poll\_url?: string Account-relative polling path. Prepend /accounts/{account_id} using the same account identifier and API host as the upload request. The path omits the account segment because the service does not have your account identifier in this context. Link to this property status?: string Current status of the upload at the moment the request returned. This is NOT a terminal state: the file is unified inline, but the durable loader has only accepted it, so the upload is still Unifying. Poll poll_url until the status reaches a terminal value (Unified or Error). Link to this property upload\_id?: number Identifier of the upload row, for polling this upload to a terminal state via poll_url. formatint64 Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds.snapshots%20%3E%20(model)%20snapshot_update_response%20%3E%20(schema)>) #### IntelIndicator FeedsPermissions ##### [List indicator feed permissions](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/subresources/permissions/methods/list) client.intel.indicatorFeeds.permissions.list(PermissionListParams {account\_id } params, RequestOptionsoptions?): [PermissionListResponse]() {id, description, is\_attributable, 3 more } GET/accounts/{account\_id}/intel/indicator-feeds/permissions/view ##### [Grant permission to indicator feed](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/subresources/permissions/methods/create) client.intel.indicatorFeeds.permissions.create(PermissionCreateParams {account\_id, account\_tag, feed\_id } params, RequestOptionsoptions?): [PermissionCreateResponse]() {success } PUT/accounts/{account\_id}/intel/indicator-feeds/permissions/add ##### [Revoke permission to indicator feed](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/indicator_feeds/subresources/permissions/methods/delete) client.intel.indicatorFeeds.permissions.delete(PermissionDeleteParams {account\_id, account\_tag, feed\_id } params, RequestOptionsoptions?): [PermissionDeleteResponse]() {success } PUT/accounts/{account\_id}/intel/indicator-feeds/permissions/remove ##### ModelsExpand Collapse
PermissionListResponse = Array<PermissionListResponseItem> id?: number The unique identifier for the indicator feed Link to this property description?: string The description of the example test Link to this property is\_attributable?: boolean Whether the indicator feed can be attributed to a provider Link to this property is\_downloadable?: boolean Whether the indicator feed can be downloaded Link to this property is\_public?: boolean Whether the indicator feed is exposed to customers Link to this property name?: string The name of the indicator feed Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds.permissions%20%3E%20(model)%20permission_list_response%20%3E%20(schema)>)
PermissionCreateResponse {success } success?: boolean Whether the update succeeded or not Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds.permissions%20%3E%20(model)%20permission_create_response%20%3E%20(schema)>)
PermissionDeleteResponse {success } success?: boolean Whether the update succeeded or not Link to this property
[Link to this property](<#(resource)%20intel.indicator_feeds.permissions%20%3E%20(model)%20permission_delete_response%20%3E%20(schema)>) #### IntelIndicator FeedsDownloads #### IntelSinkholes ##### [List sinkholes owned by this account](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/list) client.intel.sinkholes.list(SinkholeListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [Sinkhole]() {id, account\_tag, created\_on, 4 more } > GET/accounts/{account\_id}/intel/sinkholes ##### [Get a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/get) client.intel.sinkholes.get(stringsinkholeID, SinkholeGetParams {account\_id } params, RequestOptionsoptions?): [Sinkhole]() {id, account\_tag, created\_on, 4 more } GET/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id} ##### [Create a new sinkhole for your account](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/create) client.intel.sinkholes.create(SinkholeCreateParams {account\_id, name, r2\_bucket, 2 more } params, RequestOptionsoptions?): [Sinkhole]() {id, account\_tag, created\_on, 4 more } POST/accounts/{account\_id}/intel/sinkholes ##### [Update a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/update) client.intel.sinkholes.update(stringsinkholeID, SinkholeUpdateParams {account\_id, name, r2\_bucket, 2 more } params, RequestOptionsoptions?): [SinkholeUpdateResponse]() PUT/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id} ##### [Delete a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/delete) client.intel.sinkholes.delete(stringsinkholeID, SinkholeDeleteParams {account\_id } params, RequestOptionsoptions?): [SinkholeDeleteResponse]() DELETE/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id} ##### ModelsExpand Collapse
Sinkhole {id, account\_tag, created\_on, 4 more } id?: string The unique identifier for the sinkhole. Link to this property account\_tag?: string The account tag that owns this sinkhole. Link to this property created\_on?: string The date and time when the sinkhole was created. formatdate-time Link to this property modified\_on?: string The date and time when the sinkhole was last modified. formatdate-time Link to this property name?: string The name of the sinkhole. Link to this property r2\_bucket?: string The name of the R2 bucket to store results. Link to this property r2\_id?: string The id of the R2 instance. Link to this property
[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>) SinkholeUpdateResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole_update_response%20%3E%20(schema)>) SinkholeDeleteResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole_delete_response%20%3E%20(schema)>) #### IntelSinkholesIngresses ##### [Create an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/create) client.intel.sinkholes.ingresses.create(stringsinkholeID, IngressCreateParams {zone\_id, cidr } params, RequestOptionsoptions?): [IngressCreateResponse]() {id, cidr, created\_on, 3 more } POST/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses ##### [Get an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/get) client.intel.sinkholes.ingresses.get(stringingressID, IngressGetParams {zone\_id, sinkhole\_id } params, RequestOptionsoptions?): [IngressGetResponse]() {id, cidr, created\_on, 3 more } GET/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses/{ingress\_id} ##### [Update an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/update) client.intel.sinkholes.ingresses.update(stringingressID, IngressUpdateParams {zone\_id, sinkhole\_id, cidr } params, RequestOptionsoptions?): [IngressUpdateResponse]() PUT/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses/{ingress\_id} ##### [Delete an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/delete) client.intel.sinkholes.ingresses.delete(stringingressID, IngressDeleteParams {zone\_id, sinkhole\_id } params, RequestOptionsoptions?): [IngressDeleteResponse]() DELETE/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses/{ingress\_id} ##### ModelsExpand Collapse
IngressCreateResponse {id, cidr, created\_on, 3 more } id?: string The unique identifier for the ingress rule. Link to this property cidr?: string The CIDR block for the ingress rule. Link to this property created\_on?: string The date and time when the ingress rule was created. formatdate-time Link to this property modified\_on?: string The date and time when the ingress rule was last modified. formatdate-time Link to this property sinkhole\_id?: string The sinkhole this ingress rule belongs to. Link to this property zone\_tag?: string The zone tag associated with this ingress rule. Link to this property
[Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)>)
IngressGetResponse {id, cidr, created\_on, 3 more } id?: string The unique identifier for the ingress rule. Link to this property cidr?: string The CIDR block for the ingress rule. Link to this property created\_on?: string The date and time when the ingress rule was created. formatdate-time Link to this property modified\_on?: string The date and time when the ingress rule was last modified. formatdate-time Link to this property sinkhole\_id?: string The sinkhole this ingress rule belongs to. Link to this property zone\_tag?: string The zone tag associated with this ingress rule. Link to this property
[Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)>) IngressUpdateResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_update_response%20%3E%20(schema)>) IngressDeleteResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_delete_response%20%3E%20(schema)>) #### IntelAttack Surface Report #### IntelAttack Surface ReportIssue Types ##### [Retrieves Security Center Issues Types](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/attack_surface_report/subresources/issue_types/methods/get) client.intel.attackSurfaceReport.issueTypes.get(IssueTypeGetParams {account\_id } params, RequestOptionsoptions?): SinglePage< [IssueTypeGetResponse]()> GET/accounts/{account\_id}/intel/attack-surface-report/issue-types ##### ModelsExpand Collapse IssueTypeGetResponse = string [Link to this property](<#(resource)%20intel.attack_surface_report.issue_types%20%3E%20(model)%20issue_type_get_response%20%3E%20(schema)>) #### IntelAttack Surface ReportIssues ##### [Retrieves Security Center Issues](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/attack_surface_report/subresources/issues/methods/list) Deprecated client.intel.attackSurfaceReport.issues.list(IssueListParams {account\_id, dismissed, issue\_class, 12 more } params, RequestOptionsoptions?): V4PagePagination< [IssueListResponse]() {count, issues, page, per\_page } > GET/accounts/{account\_id}/intel/attack-surface-report/issues ##### [Retrieves Security Center Issue Counts by Class](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/attack_surface_report/subresources/issues/methods/class) Deprecated client.intel.attackSurfaceReport.issues.class(IssueClassParams {account\_id, dismissed, issue\_class, 10 more } params, RequestOptionsoptions?): [IssueClassResponse]() {count, value } GET/accounts/{account\_id}/intel/attack-surface-report/issues/class ##### [Retrieves Security Center Issue Counts by Severity](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/attack_surface_report/subresources/issues/methods/severity) Deprecated client.intel.attackSurfaceReport.issues.severity(IssueSeverityParams {account\_id, dismissed, issue\_class, 10 more } params, RequestOptionsoptions?): [IssueSeverityResponse]() {count, value } GET/accounts/{account\_id}/intel/attack-surface-report/issues/severity ##### [Retrieves Security Center Issue Counts by Type](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/attack_surface_report/subresources/issues/methods/type) Deprecated client.intel.attackSurfaceReport.issues.type(IssueTypeParams {account\_id, dismissed, issue\_class, 10 more } params, RequestOptionsoptions?): [IssueTypeResponse]() {count, value } GET/accounts/{account\_id}/intel/attack-surface-report/issues/type ##### ModelsExpand Collapse
IssueType = "compliance\_violation"| "email\_security"| "exposed\_infrastructure"| 3 more One of the following: "compliance\_violation" Link to this property "email\_security" Link to this property "exposed\_infrastructure" Link to this property "insecure\_configuration" Link to this property "weak\_authentication" Link to this property "configuration\_suggestion" Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20issue_type%20%3E%20(schema)>)
SeverityQueryParam = "low"| "moderate"| "critical" One of the following: "low" Link to this property "moderate" Link to this property "critical" Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20severity_query_param%20%3E%20(schema)>)
IssueListResponse {count, issues, page, per\_page } count?: number Indicates the total number of results. Link to this property
issues?: Array<Issue> id?: string Link to this property dismissed?: boolean Link to this property has\_extended\_context?: boolean Indicates whether the insight has a large payload that requires fetching via the context endpoint. Link to this property issue\_class?: string Link to this property issue\_type?: IssueType Link to this property
payload?: Payload {detection\_method, zone\_tag } detection\_method?: string Describes the method used to detect insight. Link to this property zone\_tag?: string Link to this property
Link to this property resolve\_link?: string Link to this property resolve\_text?: string Link to this property
severity?: "Low"| "Moderate"| "Critical" One of the following: "Low" Link to this property "Moderate" Link to this property "Critical" Link to this property
Link to this property since?: string formatdate-time Link to this property
status?: "active"| "resolved" The current status of the insight. One of the following: "active" Link to this property "resolved" Link to this property
Link to this property subject?: string Link to this property timestamp?: string formatdate-time Link to this property
user\_classification?: "false\_positive"| "accept\_risk"| "other"| null User-defined classification for the insight. Can be ‘false\_positive’, ‘accept\_risk’, ‘other’, or null. One of the following: "false\_positive" Link to this property "accept\_risk" Link to this property "other" Link to this property
Link to this property
Link to this property page?: number Specifies the current page within paginated list of results. Link to this property per\_page?: number Sets the number of results per page of results. maximum1000 minimum1 Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20issue_list_response%20%3E%20(schema)>)
IssueClassResponse = Array<IssueClassResponseItem> count?: number Link to this property value?: string Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20issue_class_response%20%3E%20(schema)>)
IssueSeverityResponse = Array<IssueSeverityResponseItem> count?: number Link to this property value?: string Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20issue_severity_response%20%3E%20(schema)>)
IssueTypeResponse = Array<IssueTypeResponseItem> count?: number Link to this property value?: string Link to this property
[Link to this property](<#(resource)%20intel.attack_surface_report.issues%20%3E%20(model)%20issue_type_response%20%3E%20(schema)>)