Skip to content
Start here

Create Threat Signals feed

client.cloudforceOne.threatSignals.feeds.create(FeedCreateParams { account_id, category_id, curated_feed_id, 5 more } params, RequestOptionsoptions?): FeedCreateResponse { id, category_id, category_name, 12 more }
POST/accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds

Subscribes the account to a custom or curated Threat Signals feed. Adding a custom feed when the account is at its custom-feed limit returns 403 with errors[0].reason threat_signals_feed_limit, and errors[0].custom_feed_limit and errors[0].custom_feed_count give the limit and current count. Curated feeds are not subject to this limit.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
Accepted Permissions (at least one required)
Cloudforce One Write
ParametersExpand Collapse
params: FeedCreateParams { account_id, category_id, curated_feed_id, 5 more }
account_id: string

Path param

category_id?: "b12a0fd6-f7b9-5393-9ef3-f888d506c550" | "d5b70eaa-626f-5761-b55b-6d9590df49fb" | "3b572d2b-890d-5286-9433-f18c85079030" | 5 more | null

Body param: One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories.

One of the following:
"b12a0fd6-f7b9-5393-9ef3-f888d506c550"
"d5b70eaa-626f-5761-b55b-6d9590df49fb"
"3b572d2b-890d-5286-9433-f18c85079030"
"17f90d3b-37d3-5241-8ad4-7d6abbc2006c"
"c68f28e9-7e8f-5d4b-853b-f3076893a9ee"
"bb0e4a94-38ab-5c14-80a7-28cee9f4b139"
"b1ef66d9-a73c-58dc-b269-22d34dfd11f4"
"ab02a976-0a20-5c76-a553-7f6325afacfe"
curated_feed_id?: string

Body param: UUID of a curated feed to subscribe to. Provide exactly one of url or curated_feed_id. The account must have feed creation entitlement and not exceed feed allowance.

formatuuid
display_name?: string | null

Body param: Override the feed’s display name. Null clears it; omit to keep existing or derived value.

maxLength255
enabled?: boolean

Body param: Whether to actively poll the feed. Default true.

poll_interval_s?: number

Body param: Polling interval in seconds (60-86400). Default 300s (5 minutes).

maximum86400
minimum60
title?: string | null

Body param: Override the feed’s title. Null clears it; omit to keep existing or derived value.

maxLength255
url?: string

Body param: HTTPS RSS feed URL. Provide exactly one of url or curated_feed_id. The account must have feed creation entitlement and not exceed feed allowance.

formaturi
maxLength2048
ReturnsExpand Collapse
FeedCreateResponse { id, category_id, category_name, 12 more }
id: string
formatuuid
category_id: string | null

Feed category identifier. Null when unset.

category_name: string | null

Display name of the feed category. Null when unset or unresolvable.

created_at: string
curated_feed_id: string | null

Curated catalog feed this subscription was created from. Null for custom feeds.

display_name: string | null
enabled: boolean
last_polled_at: string | null
poll_interval_s: number
source_type: string

custom for a feed added by URL, curated for a curated catalog feed.

status: string

Polling health: active, or error after a failed poll.

subscribed_at: string | null
title: string | null
updated_at: string
url: string

Create Threat Signals feed

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const feed = await client.cloudforceOne.threatSignals.feeds.create({ account_id: 'account_id' });

console.log(feed.id);
{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0,
      "custom_feed_count": 0,
      "custom_feed_limit": 0,
      "expected": "expected",
      "path": [
        "string"
      ],
      "reason": "threat_signals_feed_limit"
    }
  ],
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "category_id": "category_id",
    "category_name": "category_name",
    "created_at": "created_at",
    "curated_feed_id": "curated_feed_id",
    "display_name": "display_name",
    "enabled": true,
    "last_polled_at": "last_polled_at",
    "poll_interval_s": 0,
    "source_type": "custom",
    "status": "active",
    "subscribed_at": "subscribed_at",
    "title": "title",
    "updated_at": "updated_at",
    "url": "url"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0,
      "custom_feed_count": 0,
      "custom_feed_limit": 0,
      "expected": "expected",
      "path": [
        "string"
      ],
      "reason": "threat_signals_feed_limit"
    }
  ],
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "category_id": "category_id",
    "category_name": "category_name",
    "created_at": "created_at",
    "curated_feed_id": "curated_feed_id",
    "display_name": "display_name",
    "enabled": true,
    "last_polled_at": "last_polled_at",
    "poll_interval_s": 0,
    "source_type": "custom",
    "status": "active",
    "subscribed_at": "subscribed_at",
    "title": "title",
    "updated_at": "updated_at",
    "url": "url"
  },
  "success": true
}