Search Threat Signals articles using AI Search

GET/accounts/{account_id}/cloudforce-one/v2/threat-signals/search

Searches the account’s Threat Signals articles using keyword and semantic retrieval.

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 WriteCloudforce One Read

Path ParametersExpand Collapse

account_id: string

Query ParametersExpand Collapse

query: string

maxLength1000

minLength1

feed_id: optional string

formatuuid

max_results: optional "" or string

One of the following:

string

ReturnsExpand Collapse

errors: array of object { message }

message: string

result: object { count, results }

count: number

Number of unique article candidates returned in this response. Equal to results.length.

minimum0

results: array of object { article_id, dataset_id, event_id, 3 more }

article_id: string

formatuuid

dataset_id: string

formatuuid

event_id: string

formatuuid

feed_id: string

formatuuid

score: number

text: string

success: true

Search Threat Signals articles using AI Search

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/cloudforce-one/v2/threat-signals/search \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "result": {
    "count": 0,
    "results": [
      {
        "article_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "dataset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "event_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "feed_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "score": 0,
        "text": "text"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "result": {
    "count": 0,
    "results": [
      {
        "article_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "dataset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "event_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "feed_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "score": 0,
        "text": "text"
      }
    ]
  },
  "success": true
}