openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Threat Signals API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Threat Signals paths: /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles: get: operationId: rssArticleList summary: List Threat Signals articles description: Lists articles from the account's Threat Signals feeds. parameters: - name: account_id in: path required: true schema: type: string - name: cursor in: query description: Opaque cursor from a previous response's `next_cursor`. When provided, pagination, ordering, totals, and article filters come from the cursor. Sending `per_page`, `sort`, `include_total`, or any article filter alongside it returns a 400 `CursorFilterConflictError`. schema: description: Opaque cursor from a previous response's `next_cursor`. When provided, pagination, ordering, totals, and article filters come from the cursor. Sending `per_page`, `sort`, `include_total`, or any article filter alongside it returns a 400 `CursorFilterConflictError`. type: string minLength: 1 - name: per_page in: query schema: type: integer default: 20 maximum: 100 minimum: 1 - name: feed_id in: query schema: type: string format: uuid - name: article_id in: query schema: description: Repeatable article UUID filter. Returns the union of matching account-owned articles; use this to list every Threat Signals article referenced by an indicator's sources. type: array items: format: uuid type: string example: - 550e8400-e29b-41d4-a716-446655440000 - 660e8400-e29b-41d4-a716-446655440000 maxItems: 90 minItems: 1 - name: read in: query schema: type: boolean - name: tag_id in: query schema: description: Repeatable tag UUID filter. An article matches any selected tag. type: array items: format: uuid type: string example: - 550e8400-e29b-41d4-a716-446655440000 - name: tag_category_id in: query schema: description: Repeatable tag-category UUID filter. An article matches any selected category; when tag_id is also present, the tag and category groups are ANDed. type: array items: format: uuid type: string example: - 660e8400-e29b-41d4-a716-446655440000 maxItems: 90 minItems: 1 - name: tag in: query schema: description: Legacy human-readable tag-value filter. Ignored when tag_id is supplied; prefer tag_id. type: string deprecated: true - name: tag_category in: query schema: description: Legacy category-name disambiguator for tag. It has no effect without tag; prefer tag_category_id. type: string deprecated: true - name: include_total in: query schema: type: boolean default: false - name: search in: query schema: type: string maxLength: 500 minLength: 1 - name: published_after in: query schema: type: string format: date-time - name: published_before in: query schema: type: string format: date-time - name: fetched_after in: query schema: type: string format: date-time - name: fetched_before in: query schema: type: string format: date-time - name: feed_category in: query schema: type: string - name: source_type in: query schema: type: string enum: - curated - custom - name: tag_applied_by in: query schema: description: Assignment provenance filter. When combined with tag_id or tag_category_id, the matching assignment must have this provenance. type: string enum: - ai - analyst - system - name: sort in: query schema: type: string default: -fetched_at pattern: ^-?(fetched_at|published_at|title)$ responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: articles: type: array items: properties: dataset_id: description: Threat Events dataset identifier for the article redirect. Null when the account feeds dataset mapping is unavailable. type: - string - 'null' event_id: description: Threat Events event identifier associated with this article for a UI redirect. Null when no event has been linked. type: - string - 'null' feed_display_name: type: - string - 'null' feed_id: type: string format: uuid fetched_at: type: string id: type: string format: uuid link: type: - string - 'null' published_at: type: - string - 'null' read: type: boolean read_at: type: - string - 'null' summary: description: Persisted enrichment summary. Null until enrichment produces a summary. type: - string - 'null' tags: type: array items: properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by type: object title: type: - string - 'null' required: - id - feed_id - feed_display_name - title - link - published_at - read - read_at - tags - fetched_at - summary - event_id - dataset_id type: object has_more: type: boolean next_cursor: type: - string - 'null' total_count: type: - number - 'null' total_count_is_exact: type: boolean required: - articles - next_cursor - has_more - total_count - total_count_is_exact success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles x-fern-sdk-method-name: list x-forge-hidden: true patch: operationId: rssArticleBulkMarkRead summary: Bulk update Threat Signals article read status description: Marks up to 50 Threat Signals articles as read or unread. parameters: - name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: article_ids: type: array items: format: uuid type: string maxItems: 50 minItems: 1 read: type: boolean required: - article_ids - read responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: updated_count: type: number required: - updated_count success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles x-fern-sdk-method-name: bulk-mark-read x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}: get: operationId: rssArticleGet summary: Get Threat Signals article description: Retrieves a Threat Signals article with its summary, tags and indicator status. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: bullet_points: type: - object - 'null' properties: impact: type: string what_happened: type: string who_affected: type: string required: - what_happened - who_affected - impact content_r2_key: type: - string - 'null' feed_display_name: type: - string - 'null' feed_id: type: string format: uuid fetched_at: type: string id: type: string format: uuid indicator_extraction_status: description: Progress of the article's indicator extraction and IOC contextualization run. complete and failed are terminal; unknown means no run has been recorded. type: string enum: - in_progress - complete - failed - unknown link: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: true published_at: type: - string - 'null' read: type: boolean read_at: type: - string - 'null' skill_version: type: - string - 'null' source_count: type: number summary: description: Persisted enrichment summary. Null until enrichment produces a summary. type: - string - 'null' summary_r2_key: type: - string - 'null' tag_skill_version: type: - string - 'null' tags: type: array items: properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by type: object title: type: - string - 'null' required: - id - feed_id - feed_display_name - title - link - published_at - read - read_at - tags - fetched_at - summary - content_r2_key - summary_r2_key - bullet_points - metadata - source_count - indicator_extraction_status success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: rssArticleMarkRead summary: Update Threat Signals article read status description: Marks a Threat Signals article as read or unread. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: read: type: boolean required: - read responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: bullet_points: type: - object - 'null' properties: impact: type: string what_happened: type: string who_affected: type: string required: - what_happened - who_affected - impact content_r2_key: type: - string - 'null' feed_display_name: type: - string - 'null' feed_id: type: string format: uuid fetched_at: type: string id: type: string format: uuid indicator_extraction_status: description: Progress of the article's indicator extraction and IOC contextualization run. complete and failed are terminal; unknown means no run has been recorded. type: string enum: - in_progress - complete - failed - unknown link: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: true published_at: type: - string - 'null' read: type: boolean read_at: type: - string - 'null' skill_version: type: - string - 'null' source_count: type: number summary: description: Persisted enrichment summary. Null until enrichment produces a summary. type: - string - 'null' summary_r2_key: type: - string - 'null' tag_skill_version: type: - string - 'null' tags: type: array items: properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by type: object title: type: - string - 'null' required: - id - feed_id - feed_display_name - title - link - published_at - read - read_at - tags - fetched_at - summary - content_r2_key - summary_r2_key - bullet_points - metadata - source_count - indicator_extraction_status success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles x-fern-sdk-method-name: mark-read x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/content: get: operationId: rssArticleContentGet summary: Get Threat Signals article content description: Retrieves the stored body of a Threat Signals article as plain text or HTML. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid - name: format in: query schema: type: string enum: - text - html responses: '200': description: Threat Signals response. content: text/html: schema: type: string text/plain: schema: type: string 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles x-fern-sdk-method-name: get-content x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/skills/{skill_id}/output: get: operationId: rssArticleSkillOutputGet summary: Get Threat Signals article skill output description: Retrieves the stored output of a skill for a Threat Signals article. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid - name: skill_id in: path required: true schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: article_id: type: string format: uuid custom_output: description: Skill output. Parsed JSON when the stored output is valid JSON, otherwise the raw string. custom_skill_version: type: - string - 'null' output_schema: description: JSON-encoded output schema of the skill. Null when the skill no longer exists. type: - string - 'null' skill_id: type: string required: - article_id - skill_id - custom_skill_version - output_schema success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles.skills x-fern-sdk-method-name: get-output x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/skills/{skill_id}/run: post: operationId: rssArticleSkillRun summary: Run and persist a Threat Signals article skill description: Paid customer operation that always persists a managed default skill or an assigned active custom skill result without exposing diagnostic model data. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid - name: skill_id in: path required: true schema: anyOf: - enum: - default-tagging-skill - default-ioc-context-skill - default-summary-skill type: string - format: uuid type: string requestBody: content: application/json: schema: type: object additionalProperties: false responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: anyOf: - oneOf: - properties: bullet_points: type: - object - 'null' properties: impact: type: string what_happened: type: string who_affected: type: string required: - what_happened - who_affected - impact persisted: type: boolean enum: - true skill_id: type: string enum: - default-summary-skill skill_version: type: string summary: type: string required: - skill_id - persisted - summary - bullet_points - skill_version type: object - properties: persisted: type: boolean enum: - true skill_id: type: string enum: - default-tagging-skill tag_skill_version: type: string tags: description: Final hydrated assignment set; may be empty when no applicable tags are selected. type: array items: properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by type: object required: - skill_id - persisted - tags - tag_skill_version type: object - properties: article_id: type: string format: uuid custom_output: type: object additionalProperties: false properties: enrichments: type: array items: additionalProperties: false properties: context: type: object additionalProperties: false properties: context_snippet: type: string fetched_at: type: string published_at: type: string source_article_id: type: string format: uuid source_feed_category: type: - string - 'null' source_feed_id: type: string format: uuid source_feed_name: type: string minLength: 1 source_url: type: string required: - source_article_id - source_feed_id - source_feed_name - source_url - published_at - fetched_at - context_snippet infrastructure_assessment: type: object additionalProperties: false properties: affected_scope: type: string explanation: type: string granularity: type: string enum: - exact_indicator - subdomain - path - full_domain - unknown ownership: type: string enum: - actor_owned - compromised - abused_service - unknown parent_domain_legitimate: type: - boolean - 'null' required: - ownership - granularity - affected_scope - explanation role_classification: type: object additionalProperties: false properties: alternative_roles: type: array items: enum: - c2 - dropper - phishing_host - loader - exfil - recon type: string confidence: type: string enum: - high - medium - low evidence_snippet: type: string primary_role: type: string enum: - c2 - dropper - phishing_host - loader - exfil - recon - unknown required: - primary_role - confidence - evidence_snippet skill_metadata: type: object additionalProperties: false properties: processing_method: type: string enum: - llm_refined skill_name: type: string enum: - ioc-context-skill skill_version: type: string enum: - 1.1.0 required: - skill_name - skill_version - processing_method target_indicator_id: type: string format: uuid target_indicator_type: type: string target_indicator_value: type: string required: - target_indicator_id - target_indicator_value - target_indicator_type - context - role_classification - infrastructure_assessment - skill_metadata type: object generated_at: type: string schema_version: type: string enum: - 1.1.0 source_article_id: type: string format: uuid required: - schema_version - generated_at - source_article_id - enrichments custom_skill_version: type: string output_schema: type: string persisted: type: boolean enum: - true skill_id: type: string enum: - default-ioc-context-skill required: - skill_id - persisted - article_id - custom_output - custom_skill_version - output_schema type: object - properties: article_id: type: string format: uuid custom_output: description: JSON value conforming to the skill's output_schema custom_skill_version: type: string output_schema: type: string persisted: type: boolean enum: - true skill_id: type: string format: uuid required: - persisted - article_id - skill_id - custom_skill_version - output_schema type: object success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles.skills x-fern-sdk-method-name: run x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tag: post: operationId: rssArticleTagGenerate summary: Generate Threat Signals article AI tags description: Runs the default AI tagging skill on an article and replaces its AI-applied tags. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: tag_skill_version: type: string tags: description: Final hydrated assignment set; may be empty when no applicable tags are selected. type: array items: properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by type: object required: - tags - tag_skill_version success: type: boolean enum: - true required: - result - messages - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles.tags x-fern-sdk-method-name: generate x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tags: post: operationId: rssArticleTagAdd summary: Add tag to Threat Signals article description: Applies a tag from the account's tag catalog to a Threat Signals article. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: tag_id: type: string format: uuid required: - tag_id responses: '201': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles.tags x-fern-sdk-method-name: add x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/articles/{article_id}/tags/{tag_id}: delete: operationId: rssArticleTagRemove summary: Remove tag from Threat Signals article description: Removes a tag from a Threat Signals article. parameters: - name: account_id in: path required: true schema: type: string - name: article_id in: path required: true schema: type: string format: uuid - name: tag_id in: path required: true schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: applied_by: type: string enum: - ai - analyst - system categoryId: type: - string - 'null' format: uuid uuid: type: string format: uuid value: type: string required: - uuid - value - categoryId - applied_by success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.articles.tags x-fern-sdk-method-name: remove x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/categories: get: operationId: rssFeedCategoryList summary: List Threat Signals feed categories description: Lists the predefined categories that can be assigned to feeds. parameters: - name: account_id in: path required: true schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: categories: type: array items: properties: description: description: Plain-language description of the category. type: string id: description: Wire value accepted by the feed `category_id` field. type: string format: uuid name: description: Human-readable display label. type: string required: - id - name - description type: object required: - categories success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.categories x-fern-sdk-method-name: list x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/curated-feeds: get: operationId: rssCuratedFeedList summary: List curated Threat Signals feeds description: Lists the curated feeds the account can subscribe to. parameters: - name: account_id in: path required: true schema: type: string - name: category in: query schema: type: string maxLength: 100 - name: include_inactive in: query schema: type: boolean default: false responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: feeds: type: array items: properties: category_id: type: string display_order: type: - integer - 'null' id: type: string format: uuid is_active: type: boolean name: type: string url: type: string why_valuable: type: - string - 'null' required: - id - url - name - category_id - why_valuable - display_order - is_active type: object required: - feeds success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.curated-feeds x-fern-sdk-method-name: list x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/curated-feeds/opt-out: patch: operationId: rssCuratedFeedOptOut summary: Opt out of curated Threat Signals feeds description: Opts the account out of, or back into, the curated feed catalog. parameters: - name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: opted_out: type: boolean required: - opted_out responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: opted_out: type: boolean required: - opted_out success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.curated-feeds x-fern-sdk-method-name: opt-out x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds: get: operationId: rssFeedList summary: List Threat Signals feeds description: Lists the account's Threat Signals feed subscriptions. parameters: - name: account_id in: path required: true schema: type: string - name: page in: query schema: type: integer default: 1 minimum: 1 - name: per_page in: query schema: type: integer default: 20 maximum: 100 minimum: 1 - name: limit in: query schema: type: integer maximum: 100 minimum: 1 - name: sort in: query schema: type: string default: -created_at pattern: ^-?(created_at|title|category|url)$ - name: category in: query schema: type: string maxLength: 100 - name: source_type in: query schema: type: string enum: - curated - custom - name: enabled in: query schema: type: boolean - name: status in: query schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: count: description: Number of feeds on this page. type: integer feeds: type: array items: properties: category_id: description: Feed category identifier. Null when unset. type: - string - 'null' category_name: description: Display name of the feed category. Null when unset or unresolvable. type: - string - 'null' created_at: type: string curated_feed_id: description: Curated catalog feed this subscription was created from. Null for custom feeds. type: - string - 'null' display_name: type: - string - 'null' enabled: type: boolean id: type: string format: uuid last_polled_at: type: - string - 'null' poll_interval_s: type: integer source_type: description: '`custom` for a feed added by URL, `curated` for a curated catalog feed.' type: string example: custom status: description: 'Polling health: `active`, or `error` after a failed poll.' type: string example: active subscribed_at: type: - string - 'null' title: type: - string - 'null' updated_at: type: string url: type: string required: - id - created_at - updated_at - url - title - display_name - category_id - category_name - source_type - curated_feed_id - enabled - last_polled_at - poll_interval_s - status - subscribed_at type: object page: type: integer per_page: type: integer total_count: type: integer required: - feeds - count - page - per_page - total_count success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: rssFeedCreate summary: Create Threat Signals feed description: Subscribes the account to a custom or curated Threat Signals feed. parameters: - name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: category_id: description: One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. type: - string - 'null' enum: - 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: type: string format: uuid display_name: type: - string - 'null' maxLength: 255 enabled: type: boolean default: true poll_interval_s: type: integer default: 300 maximum: 86400 minimum: 60 title: type: - string - 'null' maxLength: 255 url: type: string format: uri maxLength: 2048 responses: '201': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: category_id: description: Feed category identifier. Null when unset. type: - string - 'null' category_name: description: Display name of the feed category. Null when unset or unresolvable. type: - string - 'null' created_at: type: string curated_feed_id: description: Curated catalog feed this subscription was created from. Null for custom feeds. type: - string - 'null' display_name: type: - string - 'null' enabled: type: boolean id: type: string format: uuid last_polled_at: type: - string - 'null' poll_interval_s: type: integer source_type: description: '`custom` for a feed added by URL, `curated` for a curated catalog feed.' type: string example: custom status: description: 'Polling health: `active`, or `error` after a failed poll.' type: string example: active subscribed_at: type: - string - 'null' title: type: - string - 'null' updated_at: type: string url: type: string required: - id - created_at - updated_at - url - title - display_name - category_id - category_name - source_type - curated_feed_id - enabled - last_polled_at - poll_interval_s - status - subscribed_at success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/poll: post: operationId: rssFeedPoll summary: Trigger Threat Signals feed poll description: Starts an immediate poll of one or all Threat Signals feeds. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: query schema: anyOf: - format: uuid type: string - enum: - all type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: errors: type: number feeds: type: array items: properties: feed_enabled: type: boolean feed_id: type: string format: uuid status: type: string enum: - workflow_created - error workflow_id: type: string required: - feed_id - workflow_id - status type: object triggered: type: number required: - feeds - triggered - errors success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: poll x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}: delete: operationId: rssFeedDelete summary: Delete Threat Signals feed description: Unsubscribes the account from a Threat Signals feed and deletes its articles. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: path required: true schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: category_id: description: Feed category identifier. Null when unset. type: - string - 'null' category_name: description: Display name of the feed category. Null when unset or unresolvable. type: - string - 'null' created_at: type: string curated_feed_id: description: Curated catalog feed this subscription was created from. Null for custom feeds. type: - string - 'null' display_name: type: - string - 'null' enabled: type: boolean id: type: string format: uuid last_polled_at: type: - string - 'null' poll_interval_s: type: integer source_type: description: '`custom` for a feed added by URL, `curated` for a curated catalog feed.' type: string example: custom status: description: 'Polling health: `active`, or `error` after a failed poll.' type: string example: active subscribed_at: type: - string - 'null' title: type: - string - 'null' updated_at: type: string url: type: string required: - id - created_at - updated_at - url - title - display_name - category_id - category_name - source_type - curated_feed_id - enabled - last_polled_at - poll_interval_s - status - subscribed_at success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: delete x-forge-hidden: true patch: operationId: rssFeedUpdate summary: Update Threat Signals feed description: Updates a Threat Signals feed subscription. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: category_id: description: One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. type: - string - 'null' enum: - 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 display_name: type: - string - 'null' maxLength: 255 enabled: type: boolean poll_interval_s: type: integer maximum: 86400 minimum: 60 title: type: - string - 'null' maxLength: 255 responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: category_id: description: Feed category identifier. Null when unset. type: - string - 'null' category_name: description: Display name of the feed category. Null when unset or unresolvable. type: - string - 'null' created_at: type: string curated_feed_id: description: Curated catalog feed this subscription was created from. Null for custom feeds. type: - string - 'null' display_name: type: - string - 'null' enabled: type: boolean id: type: string format: uuid last_polled_at: type: - string - 'null' poll_interval_s: type: integer source_type: description: '`custom` for a feed added by URL, `curated` for a curated catalog feed.' type: string example: custom status: description: 'Polling health: `active`, or `error` after a failed poll.' type: string example: active subscribed_at: type: - string - 'null' title: type: - string - 'null' updated_at: type: string url: type: string required: - id - created_at - updated_at - url - title - display_name - category_id - category_name - source_type - curated_feed_id - enabled - last_polled_at - poll_interval_s - status - subscribed_at success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}/raw: get: operationId: rssFeedRawGet summary: Get Threat Signals feed XML description: Retrieves the feed document fetched by the most recent poll. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: path required: true schema: type: string format: uuid - name: format in: query schema: type: string enum: - xml responses: '200': description: Threat Signals response. content: application/xml: schema: type: string text/plain: schema: type: string 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds x-fern-sdk-method-name: get-raw x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/feeds/{feed_id}/skills: get: operationId: rssFeedSkillsGet summary: Get Threat Signals feed skills description: Retrieves the effective skill pipeline for a Threat Signals feed. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: path required: true schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: feed_id: type: string format: uuid skills: type: array items: properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source type: object required: - feed_id - skills success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds.skills x-fern-sdk-method-name: get x-forge-hidden: true put: operationId: rssFeedSkillsSet summary: Set Threat Signals feed skills description: Replaces the ordered custom skills assigned to a Threat Signals feed. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: skill_ids: type: array items: format: uuid type: string maxItems: 20 required: - skill_ids responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: feed_id: type: string format: uuid skills: type: array items: properties: position: description: Zero-based pipeline position. type: integer skill_id: type: string required: - skill_id - position type: object required: - feed_id - skills success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.feeds.skills x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/health: get: operationId: rssHealth summary: Check Threat Signals service health description: Checks that the Threat Signals API is reachable. parameters: - name: account_id in: path required: true schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: status: type: string enum: - ok required: - status 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals x-fern-sdk-method-name: health x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/indicators: get: operationId: rssArticleIndicatorList summary: List Threat Signals article indicators description: Lists indicators of compromise extracted from the account's Threat Signals articles. parameters: - name: account_id in: path required: true schema: type: string - name: feed_id in: query schema: type: string format: uuid - name: article_id in: query schema: type: string format: uuid - name: search in: query schema: description: NFC-normalized and trimmed, case-insensitive literal substring search of indicator values. Requires 3–500 Unicode code points; the upper code-point bound is described here because OpenAPI string length cannot precisely express it without imposing UTF-16 semantics. type: string - name: per_page in: query schema: type: integer default: 20 maximum: 100 minimum: 1 - name: sort in: query schema: type: string default: id pattern: ^-?(id)$ - name: include_total in: query schema: type: boolean default: false - name: cursor in: query schema: type: string minLength: 1 responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: indicators: type: array items: properties: article_id: type: string format: uuid article_title: type: - string - 'null' dataset_id: description: Threat Events dataset identifier for navigating from this indicator. Null when the account feeds dataset mapping is unavailable. type: - string - 'null' feed_display_name: type: - string - 'null' feed_id: type: string format: uuid id: type: string format: uuid type: type: string value: type: string required: - id - type - value - article_id - feed_id - feed_display_name - article_title - dataset_id type: object pagination: type: object properties: count: type: integer minimum: 0 cursor: type: - string - 'null' has_more: type: boolean page: description: Ordinal of this cursor page; not a total-results offset. type: integer minimum: 1 per_page: type: integer maximum: 100 minimum: 1 total_count: type: - integer - 'null' minimum: 0 total_count_is_exact: type: boolean required: - page - count - per_page - total_count - total_count_is_exact - cursor - has_more required: - indicators - pagination success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.indicators x-fern-sdk-method-name: list x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/search: get: operationId: searchThreatSignals summary: Search Threat Signals articles using AI Search description: Searches the account's Threat Signals articles using keyword and semantic retrieval. parameters: - name: account_id in: path required: true schema: type: string - name: query in: query required: true schema: type: string maxLength: 1000 minLength: 1 - name: max_results in: query schema: anyOf: - enum: - '' type: string - type: string - name: feed_id in: query schema: type: string format: uuid responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: count: description: Number of unique article candidates returned in this response. Equal to results.length. type: integer minimum: 0 results: type: array items: properties: article_id: type: string format: uuid dataset_id: type: - string - 'null' format: uuid event_id: type: - string - 'null' format: uuid feed_id: type: string format: uuid score: type: number text: type: string required: - article_id - feed_id - event_id - dataset_id - score - text type: object required: - count - results success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals x-fern-sdk-method-name: search x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills: get: operationId: rssSkillList summary: List Threat Signals skills description: Lists the default and custom skills available to the account. parameters: - name: account_id in: path required: true schema: type: string - name: page in: query schema: type: integer default: 1 minimum: 1 - name: per_page in: query schema: type: integer default: 20 maximum: 100 minimum: 1 responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: count: description: Number of skills on this page. type: integer custom_skills_available: description: Whether the authenticated account may access custom-skill capabilities under Stakeout's Threat Signals access-mode policy. This is a policy availability indicator, not a row-existence indicator. False for threat_signals_only mode; true for entitled, allowlisted, cfone_internal, and service modes. type: boolean page: type: integer per_page: type: integer skills: type: array items: properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source type: object total_count: type: integer required: - skills - count - page - per_page - total_count - custom_skills_available success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: rssSkillCreate summary: Create Threat Signals skill description: Creates a custom AI skill for the account. parameters: - name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string maxLength: 100 minLength: 1 output_schema: type: string maxLength: 4096 minLength: 1 prompt: type: string maxLength: 4000 minLength: 1 type: type: string enum: - summary - tags required: - name - type - prompt - output_schema responses: '201': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id}: delete: operationId: rssSkillDelete summary: Delete Threat Signals skill description: Deletes a custom skill. Default skills cannot be deleted. parameters: - name: account_id in: path required: true schema: type: string - name: skill_id in: path required: true schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: rssSkillGet summary: Get Threat Signals skill description: Retrieves a default or custom skill by ID. parameters: - name: account_id in: path required: true schema: type: string - name: skill_id in: path required: true schema: type: string responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: rssSkillUpdate summary: Update Threat Signals skill description: Updates a custom skill. Default skills are read-only. parameters: - name: account_id in: path required: true schema: type: string - name: skill_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: config: type: string x-fern-property-name: skill-config is_active: type: boolean name: type: string maxLength: 100 minLength: 1 output_schema: type: string maxLength: 4096 minLength: 1 prompt: type: string maxLength: 4000 minLength: 1 responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object messages: type: array items: properties: code: type: number expected: type: string message: type: string path: type: array items: type: string reason: type: string enum: - free_custom_feed_limit - free_custom_skills_disabled - free_skill_run_disabled - free_tier_reconciliation_in_progress - free_tier_reconciliation_failed - raw_content_expired - curated_visibility_changed required: - message type: object result: type: object properties: config: description: JSON-encoded skill configuration. Always null for default skills. type: - string - 'null' created_at: type: string id: type: string is_active: description: 1 when active, 0 when inactive. type: integer name: type: string output_schema: description: JSON-encoded JSON Schema the skill output must satisfy. type: - string - 'null' prompt: type: string source: description: '`default` for Cloudforce One managed skills (read-only), `custom` for account skills.' type: string enum: - default - custom type: type: string example: summary updated_at: type: string required: - id - created_at - updated_at - name - type - prompt - config - output_schema - is_active - source success: type: boolean enum: - true required: - result - success - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/threat-signals/skills/{skill_id}/tag-categories: get: operationId: rssSkillTagCategoriesGet summary: Get Threat Signals skill tag categories description: Retrieves the tag categories the default tagging skill may choose tags from. parameters: - name: account_id in: path required: true schema: type: string - name: skill_id in: path required: true schema: type: string enum: - default-tagging-skill responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: category_uuids: type: array items: format: uuid type: string skill_id: type: string enum: - default-tagging-skill required: - skill_id - category_uuids success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills.tag-categories x-fern-sdk-method-name: get x-forge-hidden: true put: operationId: rssSkillTagCategoriesReplace summary: Replace Threat Signals skill tag categories description: Replaces the tag categories the default tagging skill may choose tags from. parameters: - name: account_id in: path required: true schema: type: string - name: skill_id in: path required: true schema: type: string enum: - default-tagging-skill requestBody: content: application/json: schema: type: object properties: category_uuids: type: array items: format: uuid type: string maxItems: 100 uniqueItems: true required: - category_uuids responses: '200': description: Threat Signals response. content: application/json: schema: type: object properties: errors: type: array items: properties: message: type: string required: - message type: object result: type: object properties: category_uuids: type: array items: format: uuid type: string skill_id: type: string enum: - default-tagging-skill required: - skill_id - category_uuids success: type: boolean enum: - true required: - result - success - errors 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Threat Signals x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: cloudforce-one.threat-signals.skills.tag-categories x-fern-sdk-method-name: update x-forge-hidden: true components: responses: cloudforce-one-events_ApiV4ClientError: description: Client error response. securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey api_key: in: header name: X-Auth-Key type: apiKey api_token: scheme: bearer type: http user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations