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 Reports Other 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: reports_other paths: /accounts/{account_id}/reporting/industry: get: operationId: reporting-industry-get summary: Get an account industry description: Gets the industry classification for an account. parameters: - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ responses: '200': description: Account industry retrieved successfully (returns 'unknown' if not set) content: application/json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: $ref: '#/components/schemas/reports_AccountIndustrySingleResponse' success: type: boolean enum: - true required: - success - result security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:read' x-fern-sdk-group-name: reporting.industry x-fern-sdk-method-name: get patch: operationId: reporting-industry-update summary: Update an account industry description: Updates the industry classification for an account. parameters: - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ requestBody: content: application/json: schema: $ref: '#/components/schemas/reports_PatchAccountIndustryBody' responses: '200': description: Account industry set successfully content: application/json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: $ref: '#/components/schemas/reports_AccountIndustryPatchResponse' success: type: boolean enum: - true required: - success - result '400': description: Invalid request body or industry already set to this value content: application/json: schema: $ref: '#/components/schemas/reports_AccountIndustryErrorResponse' '423': description: Industry is locked and cannot be updated until unlock_time content: application/json: schema: $ref: '#/components/schemas/reports_AccountIndustryErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/reports_AccountIndustryErrorResponse' security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:edit' x-fern-sdk-group-name: reporting.industry x-fern-sdk-method-name: update /accounts/{account_id}/reporting/policies: get: operationId: reporting-policies-list summary: List reporting policies description: Lists all reporting policies for an account. parameters: - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ responses: '200': description: List of policies retrieved successfully content: application/json: schema: $ref: '#/components/schemas/reports_PoliciesListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/reports_PolicyErrorResponse' security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:read' x-fern-sdk-group-name: reporting.policies x-fern-sdk-method-name: list /accounts/{account_id}/reporting/policies/{policy_id}: get: operationId: reporting-policies-get summary: Get a reporting policy description: Gets a reporting policy by identifier. parameters: - name: policy_id in: path required: true schema: description: Unique identifier for the policy (UUID format) type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ responses: '200': description: Policy retrieved successfully content: application/json: schema: $ref: '#/components/schemas/reports_PolicySingleResponse' '404': description: Policy not found content: application/json: schema: $ref: '#/components/schemas/reports_PolicyErrorResponse' security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:read' x-fern-sdk-group-name: reporting.policies x-fern-sdk-method-name: get /accounts/{account_id}/reporting/reports: get: operationId: reporting-reports-list summary: List generated reports description: Lists all generated reports for an account. parameters: - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ responses: '200': description: List of reports retrieved successfully content: application/json: schema: $ref: '#/components/schemas/reports_ReportsListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/reports_PolicyErrorResponse' security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:read' x-fern-sdk-group-name: reporting.reports x-fern-sdk-method-name: list /accounts/{account_id}/reporting/reports/{report_id}: get: operationId: reporting-reports-get summary: Get a generated report description: Gets a generated report by identifier. parameters: - name: account_id in: path required: true schema: description: Cloudflare public account ID (32-character hexadecimal string) type: string example: f1234567890abcdef1234567890abcdef maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ - name: report_id in: path required: true schema: description: Unique report identifier type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 responses: '200': description: Report retrieved successfully content: application/json: schema: $ref: '#/components/schemas/reports_ReportSingleResponse' '404': description: Report not found content: application/json: schema: $ref: '#/components/schemas/reports_PolicyErrorResponse' security: - api_token: [] - api_email: [] api_key: [] tags: - reports_other x-api-token-group: - '#reports:read' x-fern-sdk-group-name: reporting.reports x-fern-sdk-method-name: get components: schemas: reports_ApplicationSecurityReportV1Data: type: object properties: account_id: description: Cloudflare account ID this report was generated for type: string example: f1234567890abcdef1234567890abcdef account_name: description: Human-readable name of the account type: string example: Cloudflare Example industry: description: The industry of the account. example: internet anyOf: - description: 'Industry: Unknown' enum: - unknown title: Unknown type: string - description: 'Industry: Unsupported' enum: - unsupported title: Unsupported type: string - description: 'Industry: Accounting' enum: - accounting title: Accounting type: string - description: 'Industry: Adult Entertainment' enum: - adult_entertainment title: Adult Entertainment type: string - description: 'Industry: Agriculture' enum: - agriculture title: Agriculture type: string - description: 'Industry: Airlines, Aviation & Aerospace' enum: - airlines_aviation_aerospace title: Airlines Aviation Aerospace type: string - description: 'Industry: Animation & Design' enum: - animation_design title: Animation Design type: string - description: 'Industry: Apparel & Fashion' enum: - apparel_fashion title: Apparel Fashion type: string - description: 'Industry: Architecture & Planning' enum: - architecture_planning title: Architecture Planning type: string - description: 'Industry: Automotive' enum: - automotive title: Automotive type: string - description: 'Industry: Banking & Financial Services' enum: - banking_financial_services title: Banking Financial Services type: string - description: 'Industry: Broadcast Media' enum: - broadcast_media title: Broadcast Media type: string - description: 'Industry: Building Materials & Construction' enum: - building_materials_construction title: Building Materials Construction type: string - description: 'Industry: Business Services, Supplies & Equipment' enum: - business_services_supplies_equipment title: Business Services Supplies Equipment type: string - description: 'Industry: Computer Hardware' enum: - computer_hardware title: Computer Hardware type: string - description: 'Industry: Computer Software' enum: - computer_software title: Computer Software type: string - description: 'Industry: Construction & Civil Engineering' enum: - construction_civil_engineering title: Construction Civil Engineering type: string - description: 'Industry: Consumer Electronics' enum: - consumer_electronics title: Consumer Electronics type: string - description: 'Industry: Consumer Goods' enum: - consumer_goods title: Consumer Goods type: string - description: 'Industry: Consumer Services' enum: - consumer_services title: Consumer Services type: string - description: 'Industry: Cosmetics' enum: - cosmetics title: Cosmetics type: string - description: 'Industry: Cryptocurrency' enum: - cryptocurrency title: Cryptocurrency type: string - description: 'Industry: Cyber Security' enum: - cyber_security title: Cyber Security type: string - description: 'Industry: Defense & Space' enum: - defense_space title: Defense Space type: string - description: 'Industry: E-Learning' enum: - e_learning title: E Learning type: string - description: 'Industry: Education & Academia' enum: - education_academia title: Education Academia type: string - description: 'Industry: Education Management' enum: - education_management title: Education Management type: string - description: 'Industry: Entertainment' enum: - entertainment title: Entertainment type: string - description: 'Industry: Environmental Services' enum: - environmental_services title: Environmental Services type: string - description: 'Industry: Events Services' enum: - events_services title: Events Services type: string - description: 'Industry: Facilities Services' enum: - facilities_services title: Facilities Services type: string - description: 'Industry: Fine Art, Luxury Goods & Jewelry' enum: - fine_art_luxury_goods_jewelry title: Fine Art Luxury Goods Jewelry type: string - description: 'Industry: Food & Beverage' enum: - food_beverage title: Food Beverage type: string - description: 'Industry: Furniture' enum: - furniture title: Furniture type: string - description: 'Industry: Gambling & Casinos' enum: - gambling_casinos title: Gambling Casinos type: string - description: 'Industry: Gaming' enum: - gaming title: Gaming type: string - description: 'Industry: Government' enum: - government title: Government type: string - description: 'Industry: Health, Wellness & Fitness' enum: - health_wellness_fitness title: Health Wellness Fitness type: string - description: 'Industry: Holding Companies & Conglomerates' enum: - holding_companies_conglomerates title: Holding Companies Conglomerates type: string - description: 'Industry: Human Resources, Staffing & Recruiting' enum: - human_resources_staffing_recruiting title: Human Resources Staffing Recruiting type: string - description: 'Industry: Information Technology & Services' enum: - information_technology_services title: Information Technology Services type: string - description: 'Industry: Insurance' enum: - insurance title: Insurance type: string - description: 'Industry: International Public Affairs' enum: - international_public_affairs title: International Public Affairs type: string - description: 'Industry: International Trade & Development' enum: - international_trade_development title: International Trade Development type: string - description: 'Industry: Internet' enum: - internet title: Internet type: string - description: 'Industry: Investment Management' enum: - investment_management title: Investment Management type: string - description: 'Industry: Law Firms & Legal Services' enum: - law_firms_legal_services title: Law Firms Legal Services type: string - description: 'Industry: Leisure, Travel & Tourism' enum: - leisure_travel_tourism title: Leisure Travel Tourism type: string - description: 'Industry: Logistics, Supply Chain, Import & Export' enum: - logistics_supply_chain_import_export title: Logistics Supply Chain Import Export type: string - description: 'Industry: Management Consulting' enum: - management_consulting title: Management Consulting type: string - description: 'Industry: Manufacturing, Machinery, Technology & Engineering' enum: - manufacturing_machinery_technology_engineering title: Manufacturing Machinery Technology Engineering type: string - description: 'Industry: Maritime' enum: - maritime title: Maritime type: string - description: 'Industry: Market Research' enum: - market_research title: Market Research type: string - description: 'Industry: Marketing & Advertising' enum: - marketing_advertising title: Marketing Advertising type: string - description: 'Industry: Media Production & Publishing' enum: - media_production_publishing title: Media Production Publishing type: string - description: 'Industry: Medical Devices, Healthcare Software & Services' enum: - medical_devices_healthcare_software_services title: Medical Devices Healthcare Software Services type: string - description: 'Industry: Medical Practices, Clinics, Hospitals & Health Care' enum: - medical_practices_clinics_hospitals_health_care title: Medical Practices Clinics Hospitals Health Care type: string - description: 'Industry: Military & Law Enforcement' enum: - military_law_enforcement title: Military Law Enforcement type: string - description: 'Industry: Mining, Minerals & Metals' enum: - mining_minerals_metals title: Mining Minerals Metals type: string - description: 'Industry: Motion Pictures & Film' enum: - motion_pictures_and_film title: Motion Pictures And Film type: string - description: 'Industry: Museums & Libraries' enum: - museums_libraries title: Museums Libraries type: string - description: 'Industry: Music & Art' enum: - music_art title: Music Art type: string - description: 'Industry: Newspapers' enum: - newspapers title: Newspapers type: string - description: 'Industry: Nonprofit' enum: - nonprofit title: Nonprofit type: string - description: 'Industry: Oil, Energy, Utilities & Waste' enum: - oil_energy_utilities_waste title: Oil Energy Utilities Waste type: string - description: 'Industry: Organizations & Local Business' enum: - organizations_local_business title: Organizations Local Business type: string - description: 'Industry: Outsourcing & Offshoring' enum: - outsourcing_offshoring title: Outsourcing Offshoring type: string - description: 'Industry: Pharmaceuticals, Biotechnology & Alternative Medicine' enum: - pharmaceuticals_biotechnology_alternative_medicine title: Pharmaceuticals Biotechnology Alternative Medicine type: string - description: 'Industry: Photographic & Optical Equipment' enum: - photographic_optical_equipment title: Photographic Optical Equipment type: string - description: 'Industry: Political Organization' enum: - political_organization title: Political Organization type: string - description: 'Industry: Print & Digital Media' enum: - print_digital_media title: Print Digital Media type: string - description: 'Industry: Professional Training & Coaching' enum: - professional_training_coaching title: Professional Training Coaching type: string - description: 'Industry: Real Estate' enum: - real_estate title: Real Estate type: string - description: 'Industry: Religious Institutions' enum: - religious_institutions title: Religious Institutions type: string - description: 'Industry: Renewables & Environment' enum: - renewables_environment title: Renewables Environment type: string - description: 'Industry: Research & Think Tanks' enum: - research_think_tanks title: Research Think Tanks type: string - description: 'Industry: Restaurants' enum: - restaurants title: Restaurants type: string - description: 'Industry: Retail' enum: - retail title: Retail type: string - description: 'Industry: Security Services & Investigations' enum: - security_services_investigations title: Security Services Investigations type: string - description: 'Industry: Social Impact & Community Services' enum: - social_impact_and_community_services title: Social Impact And Community Services type: string - description: 'Industry: Sporting Goods' enum: - sporting_goods title: Sporting Goods type: string - description: 'Industry: Supermarkets & Groceries' enum: - supermarkets_groceries title: Supermarkets Groceries type: string - description: 'Industry: Telecommunications Service Providers & Carriers' enum: - telecommunications_service_providers_and_carriers title: Telecommunications Service Providers And Carriers type: string - description: 'Industry: Transportation, Shipping, Packaging & Delivery' enum: - transportation_shipping_packaging_delivery title: Transportation Shipping Packaging Delivery type: string - description: 'Industry: Travel, Lodging & Hospitality' enum: - travel_lodging_hospitality title: Travel Lodging Hospitality type: string - description: 'Industry: Wholesale' enum: - wholesale title: Wholesale type: string industry_percentile: description: Percentile ranking of this account's security posture within their industry (0-100). Null when industry is unknown/unsupported or benchmarks are unavailable. type: - number - 'null' example: 75.5 time_range: description: Time range specification for reports and queries. Used to define the period of data to include in analysis. type: object properties: end_time: description: End timestamp for the time range (exclusive). Must be after start_time. Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-08T00:00:00Z' start_time: description: Start timestamp for the time range (inclusive). Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' required: - start_time - end_time top_countries_by_mitigated_requests: description: Countries that generated the most mitigated (blocked/challenged) requests type: array items: properties: count: description: Number of requests from this country. type: integer example: 8934 minimum: 0 country_alpha2: description: The ISO 3166-1 alpha-2 country code. type: string example: US maxLength: 2 minLength: 2 required: - count - country_alpha2 type: object top_countries_by_served_requests: description: Countries that generated the most legitimate (served) requests type: array items: properties: count: description: Number of requests from this country. type: integer example: 8934 minimum: 0 country_alpha2: description: The ISO 3166-1 alpha-2 country code. type: string example: US maxLength: 2 minLength: 2 required: - count - country_alpha2 type: object top_hostnames_by_mitigated_requests: description: Hostnames with the highest number of mitigated (blocked/challenged) requests type: array items: properties: count: description: Number of requests for this hostname. type: integer example: 15420 minimum: 0 hostname: description: The hostname that received requests. type: string example: api.example.com required: - hostname - count type: object top_rules_by_mitigated_requests: description: Firewall rules that blocked or challenged the most requests type: array items: properties: count: description: Number of requests that triggered this firewall rule type: integer example: 234 minimum: 0 description: description: Human readable description of what this rule does type: string example: Block known malicious IPs kind: description: The kind of the firewall rule. example: custom anyOf: - description: The rule kind is unknown. enum: - unknown title: Unknown type: string - description: A custom rule created by the user. enum: - custom title: Custom type: string - description: A pre-defined rule managed by the system. enum: - managed title: Managed type: string rule_id: description: Unique identifier of the firewall rule type: string example: 6183d67b5b5b4a07b87e7c7a ruleset_id: description: Unique identifier of the ruleset containing this rule type: string example: efb7b8c949ac4650a09736fc source: description: The source that triggered the firewall event. example: waf anyOf: - description: 'Firewall Source: Unknown' enum: - unknown title: Unknown type: string - description: 'Firewall Source: ASN' enum: - asn title: Asn type: string - description: 'Firewall Source: Country' enum: - country title: Country type: string - description: 'Firewall Source: IP' enum: - ip title: Ip type: string - description: 'Firewall Source: IP Range' enum: - ip_range title: Ip Range type: string - description: 'Firewall Source: Security Level' enum: - security_level title: Security Level type: string - description: 'Firewall Source: Zone Lockdown' enum: - zone_lockdown title: Zone Lockdown type: string - description: 'Firewall Source: WAF' enum: - waf title: Waf type: string - description: 'Firewall Source: Firewall Rules' enum: - firewall_rules title: Firewall Rules type: string - description: 'Firewall Source: UA Block' enum: - ua_block title: Ua Block type: string - description: 'Firewall Source: Rate Limit' enum: - rate_limit title: Rate Limit type: string - description: 'Firewall Source: BIC' enum: - bic title: Bic type: string - description: 'Firewall Source: HOT' enum: - hot title: Hot type: string - description: 'Firewall Source: L7 DDOS' enum: - l7_ddos title: L7 Ddos type: string - description: 'Firewall Source: Validation' enum: - validation title: Validation type: string - description: 'Firewall Source: Bot Fight' enum: - bot_fight title: Bot Fight type: string - description: 'Firewall Source: API Shield' enum: - api_shield title: Api Shield type: string - description: 'Firewall Source: Bot Management' enum: - bot_management title: Bot Management type: string - description: 'Firewall Source: DLP' enum: - dlp title: Dlp type: string - description: 'Firewall Source: Firewall Managed' enum: - firewall_managed title: Firewall Managed type: string - description: 'Firewall Source: Firewall Custom' enum: - firewall_custom title: Firewall Custom type: string - description: 'Firewall Source: API Shield Schema Validation' enum: - api_shield_schema_validation title: Api Shield Schema Validation type: string - description: 'Firewall Source: API Shield Token Validation' enum: - api_shield_token_validation title: Api Shield Token Validation type: string - description: 'Firewall Source: API Shield Sequence Mitigation' enum: - api_shield_sequence_mitigation title: Api Shield Sequence Mitigation type: string required: - count - rule_id - ruleset_id - description - source - kind type: object total_requests: description: Summary statistics for request counts with optional period-over-period comparison type: object properties: count: description: Total count of requests. type: integer example: 1250000 minimum: 0 percent_change: description: Percentage change from the previous period (positive = increase, negative = decrease). type: number example: 15.3 required: - count total_requests_mitigated: description: Summary statistics for request counts with optional period-over-period comparison type: object properties: count: description: Total count of requests. type: integer example: 1250000 minimum: 0 percent_change: description: Percentage change from the previous period (positive = increase, negative = decrease). type: number example: 15.3 required: - count total_requests_served: description: Summary statistics for request counts with optional period-over-period comparison type: object properties: count: description: Total count of requests. type: integer example: 1250000 minimum: 0 percent_change: description: Percentage change from the previous period (positive = increase, negative = decrease). type: number example: 15.3 required: - count total_zones: description: Total number of zones (domains) in this account type: integer example: 25 minimum: 0 total_zones_analyzed: description: Number of zones that were included in this security analysis type: integer example: 23 minimum: 0 required: - account_id - account_name - time_range - total_zones - total_zones_analyzed - industry - industry_percentile - total_requests - total_requests_mitigated - total_requests_served - top_hostnames_by_mitigated_requests - top_countries_by_served_requests - top_countries_by_mitigated_requests - top_rules_by_mitigated_requests reports_ApplicationSecurityReportV1: type: object properties: input: description: Input parameters required to generate an Application Security Report V1 type: object properties: time_range: description: Time range specification for reports and queries. Used to define the period of data to include in analysis. type: object properties: end_time: description: End timestamp for the time range (exclusive). Must be after start_time. Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-08T00:00:00Z' start_time: description: Start timestamp for the time range (inclusive). Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' required: - start_time - end_time required: - time_range output: $ref: '#/components/schemas/reports_ApplicationSecurityReportV1Data' required: - input - output reports_PatchAccountIndustryBody: type: object properties: industry: description: The industry of the account example: internet anyOf: - description: 'Industry: Accounting' enum: - accounting title: Accounting type: string - description: 'Industry: Adult Entertainment' enum: - adult_entertainment title: Adult Entertainment type: string - description: 'Industry: Agriculture' enum: - agriculture title: Agriculture type: string - description: 'Industry: Airlines, Aviation & Aerospace' enum: - airlines_aviation_aerospace title: Airlines Aviation Aerospace type: string - description: 'Industry: Animation & Design' enum: - animation_design title: Animation Design type: string - description: 'Industry: Apparel & Fashion' enum: - apparel_fashion title: Apparel Fashion type: string - description: 'Industry: Architecture & Planning' enum: - architecture_planning title: Architecture Planning type: string - description: 'Industry: Automotive' enum: - automotive title: Automotive type: string - description: 'Industry: Banking & Financial Services' enum: - banking_financial_services title: Banking Financial Services type: string - description: 'Industry: Broadcast Media' enum: - broadcast_media title: Broadcast Media type: string - description: 'Industry: Building Materials & Construction' enum: - building_materials_construction title: Building Materials Construction type: string - description: 'Industry: Business Services, Supplies & Equipment' enum: - business_services_supplies_equipment title: Business Services Supplies Equipment type: string - description: 'Industry: Computer Hardware' enum: - computer_hardware title: Computer Hardware type: string - description: 'Industry: Computer Software' enum: - computer_software title: Computer Software type: string - description: 'Industry: Construction & Civil Engineering' enum: - construction_civil_engineering title: Construction Civil Engineering type: string - description: 'Industry: Consumer Electronics' enum: - consumer_electronics title: Consumer Electronics type: string - description: 'Industry: Consumer Goods' enum: - consumer_goods title: Consumer Goods type: string - description: 'Industry: Consumer Services' enum: - consumer_services title: Consumer Services type: string - description: 'Industry: Cosmetics' enum: - cosmetics title: Cosmetics type: string - description: 'Industry: Cryptocurrency' enum: - cryptocurrency title: Cryptocurrency type: string - description: 'Industry: Cyber Security' enum: - cyber_security title: Cyber Security type: string - description: 'Industry: Defense & Space' enum: - defense_space title: Defense Space type: string - description: 'Industry: E-Learning' enum: - e_learning title: E Learning type: string - description: 'Industry: Education & Academia' enum: - education_academia title: Education Academia type: string - description: 'Industry: Education Management' enum: - education_management title: Education Management type: string - description: 'Industry: Entertainment' enum: - entertainment title: Entertainment type: string - description: 'Industry: Environmental Services' enum: - environmental_services title: Environmental Services type: string - description: 'Industry: Events Services' enum: - events_services title: Events Services type: string - description: 'Industry: Facilities Services' enum: - facilities_services title: Facilities Services type: string - description: 'Industry: Fine Art, Luxury Goods & Jewelry' enum: - fine_art_luxury_goods_jewelry title: Fine Art Luxury Goods Jewelry type: string - description: 'Industry: Food & Beverage' enum: - food_beverage title: Food Beverage type: string - description: 'Industry: Furniture' enum: - furniture title: Furniture type: string - description: 'Industry: Gambling & Casinos' enum: - gambling_casinos title: Gambling Casinos type: string - description: 'Industry: Gaming' enum: - gaming title: Gaming type: string - description: 'Industry: Government' enum: - government title: Government type: string - description: 'Industry: Health, Wellness & Fitness' enum: - health_wellness_fitness title: Health Wellness Fitness type: string - description: 'Industry: Holding Companies & Conglomerates' enum: - holding_companies_conglomerates title: Holding Companies Conglomerates type: string - description: 'Industry: Human Resources, Staffing & Recruiting' enum: - human_resources_staffing_recruiting title: Human Resources Staffing Recruiting type: string - description: 'Industry: Information Technology & Services' enum: - information_technology_services title: Information Technology Services type: string - description: 'Industry: Insurance' enum: - insurance title: Insurance type: string - description: 'Industry: International Public Affairs' enum: - international_public_affairs title: International Public Affairs type: string - description: 'Industry: International Trade & Development' enum: - international_trade_development title: International Trade Development type: string - description: 'Industry: Internet' enum: - internet title: Internet type: string - description: 'Industry: Investment Management' enum: - investment_management title: Investment Management type: string - description: 'Industry: Law Firms & Legal Services' enum: - law_firms_legal_services title: Law Firms Legal Services type: string - description: 'Industry: Leisure, Travel & Tourism' enum: - leisure_travel_tourism title: Leisure Travel Tourism type: string - description: 'Industry: Logistics, Supply Chain, Import & Export' enum: - logistics_supply_chain_import_export title: Logistics Supply Chain Import Export type: string - description: 'Industry: Management Consulting' enum: - management_consulting title: Management Consulting type: string - description: 'Industry: Manufacturing, Machinery, Technology & Engineering' enum: - manufacturing_machinery_technology_engineering title: Manufacturing Machinery Technology Engineering type: string - description: 'Industry: Maritime' enum: - maritime title: Maritime type: string - description: 'Industry: Market Research' enum: - market_research title: Market Research type: string - description: 'Industry: Marketing & Advertising' enum: - marketing_advertising title: Marketing Advertising type: string - description: 'Industry: Media Production & Publishing' enum: - media_production_publishing title: Media Production Publishing type: string - description: 'Industry: Medical Devices, Healthcare Software & Services' enum: - medical_devices_healthcare_software_services title: Medical Devices Healthcare Software Services type: string - description: 'Industry: Medical Practices, Clinics, Hospitals & Health Care' enum: - medical_practices_clinics_hospitals_health_care title: Medical Practices Clinics Hospitals Health Care type: string - description: 'Industry: Military & Law Enforcement' enum: - military_law_enforcement title: Military Law Enforcement type: string - description: 'Industry: Mining, Minerals & Metals' enum: - mining_minerals_metals title: Mining Minerals Metals type: string - description: 'Industry: Motion Pictures & Film' enum: - motion_pictures_and_film title: Motion Pictures And Film type: string - description: 'Industry: Museums & Libraries' enum: - museums_libraries title: Museums Libraries type: string - description: 'Industry: Music & Art' enum: - music_art title: Music Art type: string - description: 'Industry: Newspapers' enum: - newspapers title: Newspapers type: string - description: 'Industry: Nonprofit' enum: - nonprofit title: Nonprofit type: string - description: 'Industry: Oil, Energy, Utilities & Waste' enum: - oil_energy_utilities_waste title: Oil Energy Utilities Waste type: string - description: 'Industry: Organizations & Local Business' enum: - organizations_local_business title: Organizations Local Business type: string - description: 'Industry: Outsourcing & Offshoring' enum: - outsourcing_offshoring title: Outsourcing Offshoring type: string - description: 'Industry: Pharmaceuticals, Biotechnology & Alternative Medicine' enum: - pharmaceuticals_biotechnology_alternative_medicine title: Pharmaceuticals Biotechnology Alternative Medicine type: string - description: 'Industry: Photographic & Optical Equipment' enum: - photographic_optical_equipment title: Photographic Optical Equipment type: string - description: 'Industry: Political Organization' enum: - political_organization title: Political Organization type: string - description: 'Industry: Print & Digital Media' enum: - print_digital_media title: Print Digital Media type: string - description: 'Industry: Professional Training & Coaching' enum: - professional_training_coaching title: Professional Training Coaching type: string - description: 'Industry: Real Estate' enum: - real_estate title: Real Estate type: string - description: 'Industry: Religious Institutions' enum: - religious_institutions title: Religious Institutions type: string - description: 'Industry: Renewables & Environment' enum: - renewables_environment title: Renewables Environment type: string - description: 'Industry: Research & Think Tanks' enum: - research_think_tanks title: Research Think Tanks type: string - description: 'Industry: Restaurants' enum: - restaurants title: Restaurants type: string - description: 'Industry: Retail' enum: - retail title: Retail type: string - description: 'Industry: Security Services & Investigations' enum: - security_services_investigations title: Security Services Investigations type: string - description: 'Industry: Social Impact & Community Services' enum: - social_impact_and_community_services title: Social Impact And Community Services type: string - description: 'Industry: Sporting Goods' enum: - sporting_goods title: Sporting Goods type: string - description: 'Industry: Supermarkets & Groceries' enum: - supermarkets_groceries title: Supermarkets Groceries type: string - description: 'Industry: Telecommunications Service Providers & Carriers' enum: - telecommunications_service_providers_and_carriers title: Telecommunications Service Providers And Carriers type: string - description: 'Industry: Transportation, Shipping, Packaging & Delivery' enum: - transportation_shipping_packaging_delivery title: Transportation Shipping Packaging Delivery type: string - description: 'Industry: Travel, Lodging & Hospitality' enum: - travel_lodging_hospitality title: Travel Lodging Hospitality type: string - description: 'Industry: Wholesale' enum: - wholesale title: Wholesale type: string required: - industry reports_AccountIndustrySingleResponse: type: - object - 'null' properties: industry: description: Industry string value example: internet anyOf: - description: 'Industry: Unknown' enum: - unknown title: Unknown type: string - description: 'Industry: Unsupported' enum: - unsupported title: Unsupported type: string - description: 'Industry: Accounting' enum: - accounting title: Accounting type: string - description: 'Industry: Adult Entertainment' enum: - adult_entertainment title: Adult Entertainment type: string - description: 'Industry: Agriculture' enum: - agriculture title: Agriculture type: string - description: 'Industry: Airlines, Aviation & Aerospace' enum: - airlines_aviation_aerospace title: Airlines Aviation Aerospace type: string - description: 'Industry: Animation & Design' enum: - animation_design title: Animation Design type: string - description: 'Industry: Apparel & Fashion' enum: - apparel_fashion title: Apparel Fashion type: string - description: 'Industry: Architecture & Planning' enum: - architecture_planning title: Architecture Planning type: string - description: 'Industry: Automotive' enum: - automotive title: Automotive type: string - description: 'Industry: Banking & Financial Services' enum: - banking_financial_services title: Banking Financial Services type: string - description: 'Industry: Broadcast Media' enum: - broadcast_media title: Broadcast Media type: string - description: 'Industry: Building Materials & Construction' enum: - building_materials_construction title: Building Materials Construction type: string - description: 'Industry: Business Services, Supplies & Equipment' enum: - business_services_supplies_equipment title: Business Services Supplies Equipment type: string - description: 'Industry: Computer Hardware' enum: - computer_hardware title: Computer Hardware type: string - description: 'Industry: Computer Software' enum: - computer_software title: Computer Software type: string - description: 'Industry: Construction & Civil Engineering' enum: - construction_civil_engineering title: Construction Civil Engineering type: string - description: 'Industry: Consumer Electronics' enum: - consumer_electronics title: Consumer Electronics type: string - description: 'Industry: Consumer Goods' enum: - consumer_goods title: Consumer Goods type: string - description: 'Industry: Consumer Services' enum: - consumer_services title: Consumer Services type: string - description: 'Industry: Cosmetics' enum: - cosmetics title: Cosmetics type: string - description: 'Industry: Cryptocurrency' enum: - cryptocurrency title: Cryptocurrency type: string - description: 'Industry: Cyber Security' enum: - cyber_security title: Cyber Security type: string - description: 'Industry: Defense & Space' enum: - defense_space title: Defense Space type: string - description: 'Industry: E-Learning' enum: - e_learning title: E Learning type: string - description: 'Industry: Education & Academia' enum: - education_academia title: Education Academia type: string - description: 'Industry: Education Management' enum: - education_management title: Education Management type: string - description: 'Industry: Entertainment' enum: - entertainment title: Entertainment type: string - description: 'Industry: Environmental Services' enum: - environmental_services title: Environmental Services type: string - description: 'Industry: Events Services' enum: - events_services title: Events Services type: string - description: 'Industry: Facilities Services' enum: - facilities_services title: Facilities Services type: string - description: 'Industry: Fine Art, Luxury Goods & Jewelry' enum: - fine_art_luxury_goods_jewelry title: Fine Art Luxury Goods Jewelry type: string - description: 'Industry: Food & Beverage' enum: - food_beverage title: Food Beverage type: string - description: 'Industry: Furniture' enum: - furniture title: Furniture type: string - description: 'Industry: Gambling & Casinos' enum: - gambling_casinos title: Gambling Casinos type: string - description: 'Industry: Gaming' enum: - gaming title: Gaming type: string - description: 'Industry: Government' enum: - government title: Government type: string - description: 'Industry: Health, Wellness & Fitness' enum: - health_wellness_fitness title: Health Wellness Fitness type: string - description: 'Industry: Holding Companies & Conglomerates' enum: - holding_companies_conglomerates title: Holding Companies Conglomerates type: string - description: 'Industry: Human Resources, Staffing & Recruiting' enum: - human_resources_staffing_recruiting title: Human Resources Staffing Recruiting type: string - description: 'Industry: Information Technology & Services' enum: - information_technology_services title: Information Technology Services type: string - description: 'Industry: Insurance' enum: - insurance title: Insurance type: string - description: 'Industry: International Public Affairs' enum: - international_public_affairs title: International Public Affairs type: string - description: 'Industry: International Trade & Development' enum: - international_trade_development title: International Trade Development type: string - description: 'Industry: Internet' enum: - internet title: Internet type: string - description: 'Industry: Investment Management' enum: - investment_management title: Investment Management type: string - description: 'Industry: Law Firms & Legal Services' enum: - law_firms_legal_services title: Law Firms Legal Services type: string - description: 'Industry: Leisure, Travel & Tourism' enum: - leisure_travel_tourism title: Leisure Travel Tourism type: string - description: 'Industry: Logistics, Supply Chain, Import & Export' enum: - logistics_supply_chain_import_export title: Logistics Supply Chain Import Export type: string - description: 'Industry: Management Consulting' enum: - management_consulting title: Management Consulting type: string - description: 'Industry: Manufacturing, Machinery, Technology & Engineering' enum: - manufacturing_machinery_technology_engineering title: Manufacturing Machinery Technology Engineering type: string - description: 'Industry: Maritime' enum: - maritime title: Maritime type: string - description: 'Industry: Market Research' enum: - market_research title: Market Research type: string - description: 'Industry: Marketing & Advertising' enum: - marketing_advertising title: Marketing Advertising type: string - description: 'Industry: Media Production & Publishing' enum: - media_production_publishing title: Media Production Publishing type: string - description: 'Industry: Medical Devices, Healthcare Software & Services' enum: - medical_devices_healthcare_software_services title: Medical Devices Healthcare Software Services type: string - description: 'Industry: Medical Practices, Clinics, Hospitals & Health Care' enum: - medical_practices_clinics_hospitals_health_care title: Medical Practices Clinics Hospitals Health Care type: string - description: 'Industry: Military & Law Enforcement' enum: - military_law_enforcement title: Military Law Enforcement type: string - description: 'Industry: Mining, Minerals & Metals' enum: - mining_minerals_metals title: Mining Minerals Metals type: string - description: 'Industry: Motion Pictures & Film' enum: - motion_pictures_and_film title: Motion Pictures And Film type: string - description: 'Industry: Museums & Libraries' enum: - museums_libraries title: Museums Libraries type: string - description: 'Industry: Music & Art' enum: - music_art title: Music Art type: string - description: 'Industry: Newspapers' enum: - newspapers title: Newspapers type: string - description: 'Industry: Nonprofit' enum: - nonprofit title: Nonprofit type: string - description: 'Industry: Oil, Energy, Utilities & Waste' enum: - oil_energy_utilities_waste title: Oil Energy Utilities Waste type: string - description: 'Industry: Organizations & Local Business' enum: - organizations_local_business title: Organizations Local Business type: string - description: 'Industry: Outsourcing & Offshoring' enum: - outsourcing_offshoring title: Outsourcing Offshoring type: string - description: 'Industry: Pharmaceuticals, Biotechnology & Alternative Medicine' enum: - pharmaceuticals_biotechnology_alternative_medicine title: Pharmaceuticals Biotechnology Alternative Medicine type: string - description: 'Industry: Photographic & Optical Equipment' enum: - photographic_optical_equipment title: Photographic Optical Equipment type: string - description: 'Industry: Political Organization' enum: - political_organization title: Political Organization type: string - description: 'Industry: Print & Digital Media' enum: - print_digital_media title: Print Digital Media type: string - description: 'Industry: Professional Training & Coaching' enum: - professional_training_coaching title: Professional Training Coaching type: string - description: 'Industry: Real Estate' enum: - real_estate title: Real Estate type: string - description: 'Industry: Religious Institutions' enum: - religious_institutions title: Religious Institutions type: string - description: 'Industry: Renewables & Environment' enum: - renewables_environment title: Renewables Environment type: string - description: 'Industry: Research & Think Tanks' enum: - research_think_tanks title: Research Think Tanks type: string - description: 'Industry: Restaurants' enum: - restaurants title: Restaurants type: string - description: 'Industry: Retail' enum: - retail title: Retail type: string - description: 'Industry: Security Services & Investigations' enum: - security_services_investigations title: Security Services Investigations type: string - description: 'Industry: Social Impact & Community Services' enum: - social_impact_and_community_services title: Social Impact And Community Services type: string - description: 'Industry: Sporting Goods' enum: - sporting_goods title: Sporting Goods type: string - description: 'Industry: Supermarkets & Groceries' enum: - supermarkets_groceries title: Supermarkets Groceries type: string - description: 'Industry: Telecommunications Service Providers & Carriers' enum: - telecommunications_service_providers_and_carriers title: Telecommunications Service Providers And Carriers type: string - description: 'Industry: Transportation, Shipping, Packaging & Delivery' enum: - transportation_shipping_packaging_delivery title: Transportation Shipping Packaging Delivery type: string - description: 'Industry: Travel, Lodging & Hospitality' enum: - travel_lodging_hospitality title: Travel Lodging Hospitality type: string - description: 'Industry: Wholesale' enum: - wholesale title: Wholesale type: string unlock_time: description: Time when the industry can be updated again type: - string - 'null' example: '2026-01-01T00:00:00Z' required: - industry - unlock_time reports_GetReportResponse: type: - object - 'null' properties: generated_on: description: When this report was actually completed (only present when report is finished) type: - string - 'null' example: '2024-01-15T09:05:23Z' generation_id: description: Unique identifier for this generation attempt (for retry/deduplication) type: string format: uuid example: c3d4e5f6-g7h8-9012-cdef-345678901234 policy_id: description: Reference to the policy that generated this report type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 policy_version: description: Version of the policy that was used to generate this report (positive integer starting at 1) type: integer example: 1 exclusiveMinimum: 0 reason: description: Optional reason enum providing additional context about the report status (e.g., cancellation reason, error details) example: invalid_entitlements anyOf: - description: No specific reason provided. enum: - unspecified title: Unspecified type: string - description: Report cancelled due to invalid or missing entitlements (e.g., no zones analyzed). enum: - invalid_entitlements title: Invalid Entitlements type: string - description: Report cancelled because the policy was disabled. enum: - policy_disabled title: Policy Disabled type: string report: description: The actual report data and findings oneOf: - properties: type: description: Type identifier for Application Security Report V1 type: string enum: - application_security_report_v1 value: $ref: '#/components/schemas/reports_ApplicationSecurityReportV1' required: - type - value type: object report_id: description: Unique identifier for this specific report instance type: string format: uuid example: b2c3d4e5-f6g7-8901-bcde-f23456789012 report_settings: description: Configuration settings used to generate this report, including report type and parameters (may be missing for older reports) discriminator: propertyName: type oneOf: - description: Configuration for Application Security Report with time range analysis properties: type: type: string enum: - application_security_report_v1 value: type: object properties: time_range: description: Time range that the report covers properties: end_time: description: End timestamp for the time range (exclusive). Must be after start_time. Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-08T00:00:00Z' start_time: description: Start timestamp for the time range (inclusive). Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' required: - start_time - end_time type: object required: - time_range required: - type - value title: Application Security Report V1 Settings type: object title: Report Settings report_status: description: The generation status of the report. example: scheduled anyOf: - description: The report status is unspecified. enum: - unspecified title: Unspecified type: string - description: The report is scheduled for generation. enum: - scheduled title: Scheduled type: string - description: The report is currently being generated. enum: - generating title: Generating type: string - description: The report has finished generating. enum: - finished title: Finished type: string - description: The report was cancelled and will not be generated. enum: - cancelled title: Cancelled type: string scheduled_for: description: When this report should actually run (execution timestamp) type: - string - 'null' format: date-time example: '2024-01-15T09:00:00Z' scheduled_on: description: When this report was scheduled (creation timestamp) type: - string - 'null' format: date-time example: '2024-01-15T08:30:00Z' required: - report_id - generation_id - report_status - policy_id - policy_version - scheduled_on - scheduled_for - report reports_AccountIndustryErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' messages: type: array items: {} default: [] result: {} success: type: boolean enum: - false required: - success - errors - result reports_PolicySingleResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: type: - object - 'null' properties: enabled: description: Whether the policy is currently active and will generate reports according to schedule type: boolean example: true policy_description: description: Optional detailed description of what the policy does and when it runs type: string example: Generates a comprehensive security report every Monday covering firewall events and threat analysis default: '' policy_id: description: Unique identifier for the policy (UUID format) type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 policy_name: description: Human-readable name for the policy (required, non-empty) type: string example: Weekly Security Report minLength: 1 policy_schedule: description: 'Cron expression for scheduling (format: minute hour day month weekday). Example: ''0 9 * * 1'' runs every Monday at 9:00 AM' type: string example: 0 9 * * 1 pattern: ^(\*|([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])|\*\/[0-9]+)\s+(\*|([0-9]|1[0-9]|2[0-3])|\*\/[0-9]+)\s+(\*|([1-9]|1[0-9]|2[0-9]|3[0-1])|\*\/[0-9]+)\s+(\*|([1-9]|1[0-2])|\*\/[0-9]+)\s+(\*|[0-6]|\*\/[0-9]+)$ valid_from: description: Start date when this policy version becomes effective type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' valid_to: description: End date when this policy version expires (omitted for active policies) type: - string - 'null' format: date-time example: '2024-12-31T23:59:59Z' version: description: Version number of the policy (incremented when policy is modified, starts at 1) type: integer example: 1 exclusiveMinimum: 0 required: - policy_id - policy_name - policy_schedule - enabled - version - valid_from success: type: boolean enum: - true required: - success - result reports_Error: type: object properties: code: type: number example: 10000 message: type: string example: Authentication error required: - code - message reports_ReportSingleResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: $ref: '#/components/schemas/reports_GetReportResponse' success: type: boolean enum: - true required: - success - result reports_AccountIndustryPatchResponse: type: - object - 'null' properties: industry: description: Industry string value example: internet anyOf: - description: 'Industry: Unknown' enum: - unknown title: Unknown type: string - description: 'Industry: Unsupported' enum: - unsupported title: Unsupported type: string - description: 'Industry: Accounting' enum: - accounting title: Accounting type: string - description: 'Industry: Adult Entertainment' enum: - adult_entertainment title: Adult Entertainment type: string - description: 'Industry: Agriculture' enum: - agriculture title: Agriculture type: string - description: 'Industry: Airlines, Aviation & Aerospace' enum: - airlines_aviation_aerospace title: Airlines Aviation Aerospace type: string - description: 'Industry: Animation & Design' enum: - animation_design title: Animation Design type: string - description: 'Industry: Apparel & Fashion' enum: - apparel_fashion title: Apparel Fashion type: string - description: 'Industry: Architecture & Planning' enum: - architecture_planning title: Architecture Planning type: string - description: 'Industry: Automotive' enum: - automotive title: Automotive type: string - description: 'Industry: Banking & Financial Services' enum: - banking_financial_services title: Banking Financial Services type: string - description: 'Industry: Broadcast Media' enum: - broadcast_media title: Broadcast Media type: string - description: 'Industry: Building Materials & Construction' enum: - building_materials_construction title: Building Materials Construction type: string - description: 'Industry: Business Services, Supplies & Equipment' enum: - business_services_supplies_equipment title: Business Services Supplies Equipment type: string - description: 'Industry: Computer Hardware' enum: - computer_hardware title: Computer Hardware type: string - description: 'Industry: Computer Software' enum: - computer_software title: Computer Software type: string - description: 'Industry: Construction & Civil Engineering' enum: - construction_civil_engineering title: Construction Civil Engineering type: string - description: 'Industry: Consumer Electronics' enum: - consumer_electronics title: Consumer Electronics type: string - description: 'Industry: Consumer Goods' enum: - consumer_goods title: Consumer Goods type: string - description: 'Industry: Consumer Services' enum: - consumer_services title: Consumer Services type: string - description: 'Industry: Cosmetics' enum: - cosmetics title: Cosmetics type: string - description: 'Industry: Cryptocurrency' enum: - cryptocurrency title: Cryptocurrency type: string - description: 'Industry: Cyber Security' enum: - cyber_security title: Cyber Security type: string - description: 'Industry: Defense & Space' enum: - defense_space title: Defense Space type: string - description: 'Industry: E-Learning' enum: - e_learning title: E Learning type: string - description: 'Industry: Education & Academia' enum: - education_academia title: Education Academia type: string - description: 'Industry: Education Management' enum: - education_management title: Education Management type: string - description: 'Industry: Entertainment' enum: - entertainment title: Entertainment type: string - description: 'Industry: Environmental Services' enum: - environmental_services title: Environmental Services type: string - description: 'Industry: Events Services' enum: - events_services title: Events Services type: string - description: 'Industry: Facilities Services' enum: - facilities_services title: Facilities Services type: string - description: 'Industry: Fine Art, Luxury Goods & Jewelry' enum: - fine_art_luxury_goods_jewelry title: Fine Art Luxury Goods Jewelry type: string - description: 'Industry: Food & Beverage' enum: - food_beverage title: Food Beverage type: string - description: 'Industry: Furniture' enum: - furniture title: Furniture type: string - description: 'Industry: Gambling & Casinos' enum: - gambling_casinos title: Gambling Casinos type: string - description: 'Industry: Gaming' enum: - gaming title: Gaming type: string - description: 'Industry: Government' enum: - government title: Government type: string - description: 'Industry: Health, Wellness & Fitness' enum: - health_wellness_fitness title: Health Wellness Fitness type: string - description: 'Industry: Holding Companies & Conglomerates' enum: - holding_companies_conglomerates title: Holding Companies Conglomerates type: string - description: 'Industry: Human Resources, Staffing & Recruiting' enum: - human_resources_staffing_recruiting title: Human Resources Staffing Recruiting type: string - description: 'Industry: Information Technology & Services' enum: - information_technology_services title: Information Technology Services type: string - description: 'Industry: Insurance' enum: - insurance title: Insurance type: string - description: 'Industry: International Public Affairs' enum: - international_public_affairs title: International Public Affairs type: string - description: 'Industry: International Trade & Development' enum: - international_trade_development title: International Trade Development type: string - description: 'Industry: Internet' enum: - internet title: Internet type: string - description: 'Industry: Investment Management' enum: - investment_management title: Investment Management type: string - description: 'Industry: Law Firms & Legal Services' enum: - law_firms_legal_services title: Law Firms Legal Services type: string - description: 'Industry: Leisure, Travel & Tourism' enum: - leisure_travel_tourism title: Leisure Travel Tourism type: string - description: 'Industry: Logistics, Supply Chain, Import & Export' enum: - logistics_supply_chain_import_export title: Logistics Supply Chain Import Export type: string - description: 'Industry: Management Consulting' enum: - management_consulting title: Management Consulting type: string - description: 'Industry: Manufacturing, Machinery, Technology & Engineering' enum: - manufacturing_machinery_technology_engineering title: Manufacturing Machinery Technology Engineering type: string - description: 'Industry: Maritime' enum: - maritime title: Maritime type: string - description: 'Industry: Market Research' enum: - market_research title: Market Research type: string - description: 'Industry: Marketing & Advertising' enum: - marketing_advertising title: Marketing Advertising type: string - description: 'Industry: Media Production & Publishing' enum: - media_production_publishing title: Media Production Publishing type: string - description: 'Industry: Medical Devices, Healthcare Software & Services' enum: - medical_devices_healthcare_software_services title: Medical Devices Healthcare Software Services type: string - description: 'Industry: Medical Practices, Clinics, Hospitals & Health Care' enum: - medical_practices_clinics_hospitals_health_care title: Medical Practices Clinics Hospitals Health Care type: string - description: 'Industry: Military & Law Enforcement' enum: - military_law_enforcement title: Military Law Enforcement type: string - description: 'Industry: Mining, Minerals & Metals' enum: - mining_minerals_metals title: Mining Minerals Metals type: string - description: 'Industry: Motion Pictures & Film' enum: - motion_pictures_and_film title: Motion Pictures And Film type: string - description: 'Industry: Museums & Libraries' enum: - museums_libraries title: Museums Libraries type: string - description: 'Industry: Music & Art' enum: - music_art title: Music Art type: string - description: 'Industry: Newspapers' enum: - newspapers title: Newspapers type: string - description: 'Industry: Nonprofit' enum: - nonprofit title: Nonprofit type: string - description: 'Industry: Oil, Energy, Utilities & Waste' enum: - oil_energy_utilities_waste title: Oil Energy Utilities Waste type: string - description: 'Industry: Organizations & Local Business' enum: - organizations_local_business title: Organizations Local Business type: string - description: 'Industry: Outsourcing & Offshoring' enum: - outsourcing_offshoring title: Outsourcing Offshoring type: string - description: 'Industry: Pharmaceuticals, Biotechnology & Alternative Medicine' enum: - pharmaceuticals_biotechnology_alternative_medicine title: Pharmaceuticals Biotechnology Alternative Medicine type: string - description: 'Industry: Photographic & Optical Equipment' enum: - photographic_optical_equipment title: Photographic Optical Equipment type: string - description: 'Industry: Political Organization' enum: - political_organization title: Political Organization type: string - description: 'Industry: Print & Digital Media' enum: - print_digital_media title: Print Digital Media type: string - description: 'Industry: Professional Training & Coaching' enum: - professional_training_coaching title: Professional Training Coaching type: string - description: 'Industry: Real Estate' enum: - real_estate title: Real Estate type: string - description: 'Industry: Religious Institutions' enum: - religious_institutions title: Religious Institutions type: string - description: 'Industry: Renewables & Environment' enum: - renewables_environment title: Renewables Environment type: string - description: 'Industry: Research & Think Tanks' enum: - research_think_tanks title: Research Think Tanks type: string - description: 'Industry: Restaurants' enum: - restaurants title: Restaurants type: string - description: 'Industry: Retail' enum: - retail title: Retail type: string - description: 'Industry: Security Services & Investigations' enum: - security_services_investigations title: Security Services Investigations type: string - description: 'Industry: Social Impact & Community Services' enum: - social_impact_and_community_services title: Social Impact And Community Services type: string - description: 'Industry: Sporting Goods' enum: - sporting_goods title: Sporting Goods type: string - description: 'Industry: Supermarkets & Groceries' enum: - supermarkets_groceries title: Supermarkets Groceries type: string - description: 'Industry: Telecommunications Service Providers & Carriers' enum: - telecommunications_service_providers_and_carriers title: Telecommunications Service Providers And Carriers type: string - description: 'Industry: Transportation, Shipping, Packaging & Delivery' enum: - transportation_shipping_packaging_delivery title: Transportation Shipping Packaging Delivery type: string - description: 'Industry: Travel, Lodging & Hospitality' enum: - travel_lodging_hospitality title: Travel Lodging Hospitality type: string - description: 'Industry: Wholesale' enum: - wholesale title: Wholesale type: string unlock_time: description: Time when the industry can be updated again type: - string - 'null' example: '2026-01-01T00:00:00Z' valid_from: description: Start date for this industry association type: - string - 'null' example: '2024-01-01T00:00:00Z' version: description: Version number for this association type: integer example: 1 exclusiveMinimum: 0 required: - industry - version - valid_from - unlock_time reports_PoliciesListResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: type: - array - 'null' items: properties: enabled: description: Whether the policy is currently active and will generate reports according to schedule type: boolean example: true policy_description: description: Optional detailed description of what the policy does and when it runs type: string example: Generates a comprehensive security report every Monday covering firewall events and threat analysis default: '' policy_id: description: Unique identifier for the policy (UUID format) type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 policy_name: description: Human-readable name for the policy (required, non-empty) type: string example: Weekly Security Report minLength: 1 policy_schedule: description: 'Cron expression for scheduling (format: minute hour day month weekday). Example: ''0 9 * * 1'' runs every Monday at 9:00 AM' type: string example: 0 9 * * 1 pattern: ^(\*|([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])|\*\/[0-9]+)\s+(\*|([0-9]|1[0-9]|2[0-3])|\*\/[0-9]+)\s+(\*|([1-9]|1[0-9]|2[0-9]|3[0-1])|\*\/[0-9]+)\s+(\*|([1-9]|1[0-2])|\*\/[0-9]+)\s+(\*|[0-6]|\*\/[0-9]+)$ valid_from: description: Start date when this policy version becomes effective type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' valid_to: description: End date when this policy version expires (omitted for active policies) type: - string - 'null' format: date-time example: '2024-12-31T23:59:59Z' version: description: Version number of the policy (incremented when policy is modified, starts at 1) type: integer example: 1 exclusiveMinimum: 0 required: - policy_id - policy_name - policy_schedule - enabled - version - valid_from type: object success: type: boolean enum: - true required: - success - result reports_PolicyErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' messages: type: array items: {} default: [] result: {} success: type: boolean enum: - false required: - success - errors - result reports_ReportsListResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/reports_Error' default: [] messages: type: array items: $ref: '#/components/schemas/reports_Message' default: [] result: type: - array - 'null' items: properties: generated_on: description: When this report was actually completed (only present when report is finished) type: - string - 'null' example: '2024-01-15T09:05:23Z' generation_id: description: Unique identifier for this generation attempt (for retry/deduplication) type: string format: uuid example: c3d4e5f6-g7h8-9012-cdef-345678901234 policy_id: description: Reference to the policy that generated this report type: string format: uuid example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 policy_version: description: Version of the policy that was used to generate this report (positive integer starting at 1) type: integer example: 1 exclusiveMinimum: 0 reason: description: Optional reason enum providing additional context about the report status (e.g., cancellation reason, error details) example: invalid_entitlements anyOf: - description: No specific reason provided. enum: - unspecified title: Unspecified type: string - description: Report cancelled due to invalid or missing entitlements (e.g., no zones analyzed). enum: - invalid_entitlements title: Invalid Entitlements type: string - description: Report cancelled because the policy was disabled. enum: - policy_disabled title: Policy Disabled type: string report_id: description: Unique identifier for this specific report instance type: string format: uuid example: b2c3d4e5-f6g7-8901-bcde-f23456789012 report_settings: description: Configuration settings used to generate this report, including report type and parameters (may be missing for older reports) discriminator: propertyName: type oneOf: - description: Configuration for Application Security Report with time range analysis properties: type: type: string enum: - application_security_report_v1 value: type: object properties: time_range: description: Time range that the report covers properties: end_time: description: End timestamp for the time range (exclusive). Must be after start_time. Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-08T00:00:00Z' start_time: description: Start timestamp for the time range (inclusive). Accepts ISO 8601 date strings or Date objects. type: - string - 'null' format: date-time example: '2024-01-01T00:00:00Z' required: - start_time - end_time type: object required: - time_range required: - type - value title: Application Security Report V1 Settings type: object title: Report Settings report_status: description: The generation status of the report. example: scheduled anyOf: - description: The report status is unspecified. enum: - unspecified title: Unspecified type: string - description: The report is scheduled for generation. enum: - scheduled title: Scheduled type: string - description: The report is currently being generated. enum: - generating title: Generating type: string - description: The report has finished generating. enum: - finished title: Finished type: string - description: The report was cancelled and will not be generated. enum: - cancelled title: Cancelled type: string scheduled_for: description: When this report should actually run (execution timestamp) type: - string - 'null' format: date-time example: '2024-01-15T09:00:00Z' scheduled_on: description: When this report was scheduled (creation timestamp) type: - string - 'null' format: date-time example: '2024-01-15T08:30:00Z' required: - report_id - generation_id - report_status - policy_id - policy_version - scheduled_on - scheduled_for type: object success: type: boolean enum: - true required: - success - result reports_Message: type: object properties: code: type: number example: 10000 message: type: string example: This is an example message required: - code - message 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